IDataQuerySettings Interface

Data query parameters interface

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 12.0.0

Syntax

public interface IDataQuerySettings : IWhereCondition, 
	IQueryParameters, IQueryObject, IDisposable

The IDataQuerySettings type exposes the following members.

Properties

	Name	Description
Public property	DataSourceName	Data source identifier that represents the location from which the data are obtained. (Inherited from IWhereCondition.)
Public property	DefaultQuerySource	Default source of the query in case source is not defined
Public property	FilterColumns	List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"
Public property	GroupByColumns	List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
Public property	HasGroupBy	Returns true if the given query has group by set
Public property	HavingCondition	Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
Public property	IsNested	Indicates that this query is nested within another query as its source. This brings certain constraints such as that is cannot use CTE.
Public property	IsPagedQuery	Returns true if the query has the paging enabled
Public property	IsSubQuery	If true, the query is a sub-query used in another query. This brings certain constraints such as that it cannot use order by or CTE.
Public property	MaxRecords	Maximum number of results to return (use for paging together with Offset)
Public property	Name	Object name, empty by default (Inherited from IQueryObject.)
Public property	Offset	Index of the first record to return (use for paging together with MaxRecords)
Public property	OrderByColumns	List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"
Public property	Parameters	Query data parameters (Inherited from IQueryObject.)
Public property	QuerySource	Source of the query
Public property	SelectColumnsList	List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
Public property	SelectDistinct	If set to true, returns only distinct (different) values.
Public property	TopNRecords	If set, selects only first top N number of records
Public property	TotalExpression	Total items expression. When defined, used instead default total items for a paged query.
Public property	WhereCondition	Where condition on the data, e.g. "DocumentName = 'ABC'" (Inherited from IWhereCondition.)
Public property	WhereIsComplex	Returns true if the given where condition contains compound conditions, e. g. "A > 1 AND B = 5" (Inherited from IWhereCondition.)
Public property	WhereIsEmpty	Returns true if the where condition is empty (Inherited from IWhereCondition.)

Methods

	Name	Description
Public method	ApplyParametersTo	Applies this where condition to the target object (Inherited from IQueryParameters.)
Public method	Changed	Marks the object as changed (Inherited from IQueryObject.)
Public method	CloneObject	Creates the clone of the object. (Inherited from IQueryObject.)
Public method	CopyPropertiesTo	Copies the properties to the target query. (Inherited from IQueryParameters.)
Public method	EnsureParameters	Ensures data parameters for the given query (Inherited from IQueryParameters.)
Public method	Expand	Expands the expression by replacing parameters with their values (Inherited from IQueryParameters.)
Public method	IncludeDataParameters	Adds the data parameters to the current query parameters (Inherited from IQueryObject.)
Public method	ReturnNoResults	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 method	ToString	Returns the string representation of the expression, with possibility of expanding parameters (Inherited from IQueryParameters.)