Click or drag to resize
IDataQuerySettings Interface
Data query parameters interface

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 8.2.23
public interface IDataQuerySettings : IWhereCondition, 
	IQueryParameters, IQueryObject, IDisposable

The IDataQuerySettings type exposes the following members.

Public methodApplyParametersTo
Applies this where condition to the target object
(Inherited from IQueryParameters.)
Public methodCloneObject
Creates the clone of the object.
(Inherited from IQueryObject.)
Public methodEnsureParameters
Ensures data parameters for the given query
(Inherited from IQueryParameters.)
Public methodExpand
Expands the expression by replacing parameters with their values
(Inherited from IQueryParameters.)
Public methodChanged
Marks the object as changed
(Inherited from IQueryObject.)
Public methodIncludeDataParameters
Adds the data parameters to the current query parameters
(Inherited from IQueryObject.)
Public methodReturnNoResults
Sets the query to return no results. This action is irreversible, once the query is set to return no results it cannot be changed. This method is used by data engine to forbid access to data that are not allowed to be accessed (e.g. license limitations), without notifying the process about the fact.
(Inherited from IWhereCondition.)
Public methodToString
Returns the string representation of the expression, with possibility of expanding parameters
(Inherited from IQueryParameters.)
Public propertyDefaultSourceExpression
Default source of the query in case source is not defined
Public propertyFilterColumns
List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"
Public propertyGroupByColumns
List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
Public propertyHavingCondition
Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
Public propertyIsNested
Indicates that this query is part of multi query
Public propertyIsSubQuery
If true, the query is a sub-query used in another query
Public propertyMaxRecords
Maximum number of results to return (use for paging together with Offset)
Public propertyName
Object name, empty by default
(Inherited from IQueryObject.)
Public propertyOffset
Index of the first record to return (use for paging together with MaxRecords)
Public propertyOrderByColumns
List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"
Public propertyParameters
Query data parameters
(Inherited from IQueryObject.)
Public propertySelectColumns Obsolete.
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
Public propertySelectColumnsList
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
Public propertySelectDistinct
If set to true, returns only distinct (different) values.
Public propertySourceExpression
Source of the query
Public propertyTopNRecords
If set, selects only first top N number of records
Public propertyWhereCondition
Where condition on the data, e.g. "DocumentName = 'ABC'"
(Inherited from IWhereCondition.)
Public propertyWhereIsComplex
Returns true if the given where condition contains compound conditions, e. g. "A > 1 AND B = 5"
(Inherited from IWhereCondition.)
See Also