DatStat Illume 4.5 SDK Class Reference

SDK_Query Members

SDK_Query overview

Public Instance Properties

CrossTabVariable This property is used to retrieve or specify a survey variable containing a scale that is used for cross-tabulation if summary statistics are requested.
DataDictionary The data dictionary of the survey referred to by this query.
DownloadOutputType The DatStat Illume SDK_ResultsType that will be used to format a download of this query. This is relevant if this SDK_Query is being executed via the ExecuteQuery method whose signature requires a TextWriter. It is not relevant for the ExecuteQuery method which returns a DataSet.
IncludeLabels Indicates if labels should be included in the raw results returned from this query.
IncludePartialData Indicates if partial submission data should be included in the query result set.
QueryResultType The DatStat Illume SDK_QueryResultType for this query.
RawDataTableName Returns the name of the DataTable in the DataSet that holds the raw data. For more information on the structure of the returned DataSet, see the ExecuteQuery method.
SelectList String array of variable id values to be returned in the results set.
SummaryDataTableName Returns the name of the DataTable in the DataSet that holds the summary data. For more information on the structure of the returned DataSet, see the ExecuteQuery method.
SurveyId The Id of the survey that is the source for the query.
TestDataOnly Indicates if test data only should be returned from this query.

Public Instance Methods

AddFilter Filters can be added to a query to limit the results returned from the query.
AddSort Indicates that a particular variable in the result set should be used to sort the results. Query results can be sorted by any variable included in the SelectList property. More than one sort can be added by calling AddSort more than once. The first sort defined will be the primary sort, with subsequent sorts applied in the order they are added.
ClearFilters Clears all filter definitions for the query.
ClearSorts Clears all sorting definitions for the query.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
SetQueryFilterType Multiple filters can be combined in one of three ways. If all expressions must be true for a filter to be met, Set the SDK_QueryFilterType to And. If one of the expressions must be true for a filter to be met, Set the SDK_QueryFilterType to Or. You can also logically arrange how the filters are evaluated by creating a complex expression that logically combines the defined filters.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

SDK_Query Class | DatStat.SDK.WebServiceWrappers Namespace