Library Specification Object Model Reference |
|
Spss.Dimensions.Library.Specification Namespace
Namespace hierarchy
Classes
Class |
Description |
LibraryQuery
|
An enumeration of the fields available from the search results. |
QLAssetExistsException
|
Exception thrown when a QLAsset already exists within the Library. |
QLAssetNotFoundException
|
Exception thrown when attempting to get a SurveyAsset which doesn't appear to exist. |
QLException
|
An exception throws from the Question Library. |
QLLibrary
|
QLLibrary is a singleton class used to access the individual question libraries which have been configured via the configuration file. |
QLLibraryDriverEntry
|
Represents a library driver entry. |
QLLibrarySettings
|
The question library settings is used to store the currently known and configured question libraries for a user (or installation). This is loaded from the user or system settings file. |
QLLibrarySettingsEntry
|
Represents a configured library. Subclass this to add implementation specific information for a specific library implementation. |
QLLibrarySettingsEntry.Property
|
A Property represents a single named/value pair which can be stored as part of a Library's settings. |
QLLog
|
The QLLog class is a static class providing logging capabilities for the QLAPI. |
SettingsEntryAddedEventArgs
|
Event args that are provided to the SettingsEntryAddedEventHandler. |
SettingsEntryRemovedEventArgs
|
Event args that are provided to the SettingsEntryRemovedEventHandler. |
SettingsEntryUpdatedEventArgs
|
Event args that are provided to the SettingsEntryUpdatedEventHandler. |
SpecificationAppContext
|
This class will be eventually be wrapped into the Spss.Dimensions.Libaray.Controls.QLAppContext. It contains properties specific to the QL Specification layer that we will bubble up to the QLAppContext. This class follows the Singleton pattern. |
SurveyAssetSavedEventArgs
|
The SurveyAssetSavedEventArgs is used to collect any properties that should be required to handle a SurveyAssetSavedEvent. |
Interfaces
Interface |
Description |
ICheckList
|
A checklist is a set of items that need to be signed off upon during the review process. |
ICheckListItem
|
A checklist item is an individual item that should be completed as part of the review process |
ICheckoutStatus
|
Shows the current checkout status and allows the status to be updated |
ICheckoutStatusItem
|
Represents one user's current checkout status |
IFilterCriteria
|
Used to filter SurveyAssets |
ILibrary
|
Represents a Library of QueryAssets. The ILibrary interfaces provides factory capabilities for creating the items that can be stored in the library. |
ILibraryConfiguration
|
A Library Configuration Interface. |
ILibraryDriver
|
The primary interface of the library driver. Survey tools use this to access the Dimensions Question Library. Providers of a question library implement this interface. |
IQLAttribute
|
Attributes can be added to a survey asset to define its purpose and capabilities. |
IQLAttributeAllowedValue
|
This defines an allowed string value for a question library attribute |
IQLAttributeAllowedValueCollection
|
A collection containing the allowed values for an attribute |
IQLAttributeCollection
|
A list of attributes |
IQLProperties
|
Defines a set of properties that can be applied to an item. |
IReviewHistory
|
Review history tracks all things related to the review process for an item |
IReviewNote
|
A particular note |
IReviewNotes
|
Notes provided during the review cycle |
IReviewProcess`1
|
A generic interface used for querying review-cycle information |
ISecurityProvider
|
A Security Provider Interface. |
IStage
|
When a new survey item is submitted to the library it will go through 1 or more stages. The stages represent steps in the review process, and the final stage is always the "approved" stage. Other common stages may include 'Review' and 'Translate', and are defined by an administrator. |
IStageCollection
|
This is an ordered collection of stages an item may progress as it goes through the apporoval process. Items should typically be submitted to the first stage (but callers have the flexibility to submit items to any stage). |
ISurveyAsset
|
A survey asset is a Dimensions MZD file which can contain any arbitrary survey asset. This includes, but is not limited to questions, scripts, table definitions. Additionally, files associated with the asset may be added to the asset, providing a convenient method of grouping related files together.
|
ISurveyAssetCollection
|
A collection of survey assets |
ITopic
|
Items within the library may be organized under topics. 'Demographics' and 'Brand Awareness' are examples of topics. A topic may be further broken down into subtopics. The subtopics for 'Demographics' would include 'Age' and 'Gender'. An item may be classified under any number of topics. |
ITopicCollection
|
This is a collection of (sub)topics. |
Delegates
Enumerations
Enumeration |
Description |
AssetType
|
An enumeration of AssetType. |
CheckoutStatus
|
An enumeration of values which describe the type of check out status. |
DataType
|
An enumeration of DataTypes that are supported by IQLAttributes. A DataType refers to what type of data an IQLAttribute holds. |
LibraryCapability
|
Tools can query the capabilities of a library. This is the list of capabilities that can be queried. |
QLPermission
|
An enumeration of values which describe the type of permissions. |
SaveType
|
The type of save this event args corresponds to. |
ValidateStatus
|
An enumeration of values which describe the type of validation error encountered. |
ValueType
|
An enumeration of ValueTypes that are supported by IQLAttributes. A ValueType refers to what type of IQLAttribute value is valid. |