Library Commands Object Model Reference

Spss.Dimensions.Library.Commands Namespace

Namespace hierarchy

Classes

Class Description
AttachedFile This helper class is used to represent attached files for a survey asset. A file could be on the file system or in a mzd(zip) file.
CommandAppContext This class will be eventually be wrapped into the Spss.Dimensions.Libaray.Controls.QLAppContext. It contains properties specific to the Command layer that we will bubble up to the QLAppContext. This class follows the Singleton pattern.
CommandConstants Add common constants for the Command project to this class
CommandLineLibrarySearch Perform a CommandLine search
CustomAttributesDataSet The CustomIndicesDataSet is used to generate a data set for a SurveyAsset which contains the information about the confired QLAttributes for a particular library.
CustomAttributesDataSet.AttributesDataTable Represents the strongly named DataTable class.
CustomAttributesDataSet.AttributesRow The IndexTableRow is a row contained within the IndexTable.
CustomAttributesDataSet.AttributesRowChangeEvent Row event argument class
DownloadSurveyCommand The DownloadSurveyCommand can be used to download the latest SurveyAsset command from the first stage, and expand the archive into a specified directory.
ExecutionStatusEventArgs Helper EventArgs Class for transferring events for execution status.
FilesDataSet Represents a strongly typed in-memory cache of data.
FilesDataSet.FilesDataTable Represents the strongly named DataTable class.
FilesDataSet.FilesRow Represents strongly named DataRow class.
FilesDataSet.FilesRowChangeEvent Row event argument class
LibraryConnectionCommand This command can be used to connect to (or 'mount) a library. To use, first it must be instantiated with a QLLibrarySettings instance. Then, if the default user name and password are not those you wish to connect with, simply update the command's User and Password properties (will not change underlying settings). When you are ready to connect to the library, call the Execute method, which will set the instance's Library property to the same value that is returned.
LibrarySearchCommand Base class for the search commands
ListsDataSet Represents an in-memory cache of simple Lists data.
ListsDataSet.ListDataTable The table in the ListsDataSet.
ListsDataSet.ListRow Represents strongly named DataRow class.
ListsDataSet.ListRowChangeEvent Row event argument class
QuestionsDataSet Represents an in-memory cache of simple Questions data.
QuestionsDataSet.QuestionDataTable Represents the strongly named DataTable class.
QuestionsDataSet.QuestionRow Represents strongly named DataRow class.
QuestionsDataSet.QuestionRowChangeEvent Row event argument class
SearchResultDataSet Represents an in-memory cache of library search result data.
SearchResultDataSet.LibraryAssetsDataTable Represents the strongly named DataTable class.
SearchResultDataSet.LibraryAssetsRow Represents strongly named DataRow class.
SearchResultDataSet.LibraryAssetsRowChangeEvent Row event argument class
StructuredLibrarySearch Perform a structured search.
SurveySubmissionCommand The SurveySubmissionCommand can be used to submit a survey into the library. This submission may be an initial insertion, or a subsequent update and may include any number of comments and/or associated files. The Survey being submitted *MUST* be saved locally, and be allowed to be saved and writeable. During execution of this command, custom properties will be added and the survey will be saved to its current location.
ValidateNameCommand This command checks to see if the name you are using for the Survey Asset is unique. In other words it checks all the stages and makes sure the asset name has not been used.

Delegates

Delegate Description
CustomAttributesDataSet.AttributesRowChangeEventHandler  
DownloadSurveyCommand.DownloadSurveyErrorHandler Delegate which may optionally be supplied to Execute method which can be used to handle errors.
ExecutionStatusHandler Helper Delegate Class for handling execution status events.
FilesDataSet.FilesRowChangeEventHandler  
LibraryConnectionCommand.ErrorHandler A delegate that may be used as an ErrorHandler for the command's execute method.
LibrarySearchCommand.AddCriteria The definition of function AddCriteria.
ListsDataSet.ListRowChangeEventHandler  
QuestionsDataSet.QuestionRowChangeEventHandler  
SearchResultDataSet.LibraryAssetsRowChangeEventHandler  
SurveySubmissionCommand.ErrorHandler Defines an ErrorHandler that can be used to handle errors encountered during the execution of thsi command.
ValidateNameCommand.ErrorHandler Defines an ErrorHandler that can be used to handle errors encountered during the execution of thsi command.

Enumerations

Enumeration Description
DownloadSurveyCommand.ErrorType An enumeration of the types of errors that can be encountered while download a survey asset.
LibraryConnectionCommand.ErrorType An enumeration of possible errors that could have been encountered.
SurveySubmissionCommand.ErrorType An enumeration of error types that may be encountered while executing the SurveySubmissionCommand.
ValidateNameCommand.ErrorType An enumeration of values which describe the type of error.