IDocumentQuery<TQuery, TObject> Interface

Document query parameters interface for a specific query

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 9.0.0

Syntax

public interface IDocumentQuery<TQuery, TObject> : IObjectQuery<TQuery, TObject>, 
	IDataQuery<TQuery>, IDataQuerySettings<TQuery>, IWhereCondition<TQuery>, 
	IDocumentQuery, IObjectQuery, IDataQuery, IDataQuerySettings, IWhereCondition, 
	IQueryParameters, IDisposable, IQueryObjectWithValue, IQueryObject
where TObject : new(), TreeNode

Type Parameters

TQuery

TObject

The IDocumentQuery<TQuery, TObject> type exposes the following members.

Properties

	Name	Description
Public property	AllowMaterialization	If true, the query allows materialization (Inherited from IDataQuery.)
Public property	ClassName	Class name (Inherited from IDataQuery.)
Public property	ConnectionStringName	Query connection string name (Inherited from IDataQuery.)
Public property	Count	Number of actual records retrieved from the database (Inherited from IDataQuery.)
Public property	CustomQueryText	Custom query text (Inherited from IDataQuery.)
Public property	DataSource	Data source that provides the query data. If not set, the query queries the database directly (Inherited from IDataQuery.)
Public property	DataSourceName	Data source identifier that represents the location from which the data are obtained. (Inherited from IWhereCondition.)
Public property	DefaultOrderByColumns	Default order by columns used in case if needed, and order by is not specified (Inherited from IDataQuery.)
Public property	DefaultQuerySource	Default source of the query in case source is not defined (Inherited from IDataQuerySettings.)
Public property	DefaultSourceExpression	Obsolete. Default source of the query in case source is not defined (Inherited from IDataQuerySettings.)
Public property	FilterColumns	List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN" (Inherited from IDataQuerySettings.)
Public property	FirstObject	Returns first object from the query result DataSet. The property does not limit the actual number of fetched rows. (Inherited from IObjectQuery<TQuery, TObject>.)
Public property	GroupByColumns	List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner" (Inherited from IDataQuerySettings.)
Public property	HasDataSource	Returns true if the query has specific data source (Inherited from IDataQuery.)
Public property	HasGroupBy	Returns true if the given query has group by set (Inherited from IDataQuerySettings.)
Public property	HavingCondition	Where condition for the group by on the data, e.g. "DocumentName = 'ABC'" (Inherited from IDataQuerySettings.)
Public property	IncludeBinaryData	If true, the query includes the object binary data (Inherited from IDataQuery.)
Public property	IsCombinedQuery	If true, this query is combined from several queries. When additional parameters are applied to it, it will be wrapped into a nested query. (Inherited from IDataQuery.)
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. (Inherited from IDataQuerySettings.)
Public property	IsPagedQuery	Returns true if the query has the paging enabled (Inherited from IDataQuerySettings.)
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. (Inherited from IDataQuerySettings.)
Public property	MaxRecords	Maximum number of results to return (use for paging together with Offset) (Inherited from IDataQuerySettings.)
Public property	Name	Object name, empty by default (Inherited from IQueryObject.)
Public property	ObjectType	Returns the object type of the objects stored within the collection. (Inherited from IObjectQuery.)
Public property	Offset	Index of the first record to return (use for paging together with MaxRecords) (Inherited from IDataQuerySettings.)
Public property	OrderByColumns	List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC" (Inherited from IDataQuerySettings.)
Public property	Parameters	Query data parameters (Inherited from IQueryObject.)
Public property	Properties	Document query parameters. (Inherited from IDocumentQuery.)
Public property	QueryName	Query name (Inherited from IDataQuery.)
Public property	QuerySource	Source of the query (Inherited from IDataQuerySettings.)
Public property	QueryText	Query text (Inherited from IDataQuery.)
Public property	Result	DataSet with the result (Inherited from IDataQuery.)
Public property	ReturnsSingleColumn	Returns true if the query returns single column (Inherited from IDataQuery.)
Public property	SelectColumnsList	List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID" (Inherited from IDataQuerySettings.)
Public property	SelectDistinct	If set to true, returns only distinct (different) values. (Inherited from IDataQuerySettings.)
Public property	SourceExpression	Obsolete. Source of the query (Inherited from IDataQuerySettings.)
Public property	SupportsReader	Returns true if the query supports data reader (Inherited from IDataQuery.)
Public property	Tables	Collection of the result tables (Inherited from IDataQuery.)
Public property	TopNRecords	If set, selects only first top N number of records (Inherited from IDataQuerySettings.)
Public property	TotalExpression	Total items expression. When defined, used instead default total items for a paged query. (Inherited from IDataQuerySettings.)
Public property	TotalRecords	Gets the number of total records when paging is used. Gets updated once the query executes (Inherited from IDataQuery.)
Public property	TypedResult	Typed result (Inherited from IObjectQuery<TQuery, TObject>.)
Public property	UseObjectTypeCondition	If true, the query uses the object type condition. (Inherited from IObjectQuery.)
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	AddColumn(String)	Adds the additional column to the query (Inherited from IDataQuerySettings<TQuery>.)
Public method	AddColumn(IQueryColumn)	Adds the additional column to the query (Inherited from IDataQuerySettings<TQuery>.)
Public method	AddColumns(IEnumerable<String>)	Adds the additional columns to the query (Inherited from IDataQuerySettings<TQuery>.)
Public method	AddColumns(String[])	Adds the additional columns to the query (Inherited from IDataQuerySettings<TQuery>.)
Public method	AddColumns(IQueryColumn[])	Adds the additional columns to the query (Inherited from IDataQuerySettings<TQuery>.)
Public method	All	Ensures that there is no restriction applied for the result.
Public method	AllCultures	Ensures that all culture versions of the documents are retrieved.
Public method	And()	Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where... (Inherited from IWhereCondition<TParent>.)
Public method	And(IWhereCondition)	Adds the given where condition with the AND operator (Inherited from IWhereCondition<TParent>.)
Public method	And(Action<WhereCondition>)	Adds the given where condition with the AND operator. Creates a new where condition object and runs the setup actions on it. (Inherited from IWhereCondition<TParent>.)
Public method	ApplyParametersTo	Applies this where condition to the target object (Inherited from IQueryParameters.)
Public method	ApplySettings(AbstractQueryObject)	Applies the given settings to the query (Inherited from IDataQuery.)
Public method	ApplySettings(Action<DataQuerySettings>)	Applies the given settings to the query (Inherited from IDataQuery.)
Public method	As<T>	Changes the type of the query to another type (Inherited from IDataQuery.)
Public method	AsIDQuery	Creates an ID query from the given query (Inherited from IDataQuery.)
Public method	AsMaterializedList	Makes a materialized list from the given query (Inherited from IDataQuery.)
Public method	AsNested()	Creates a nested query from the given query (Inherited from IObjectQuery<TQuery, TObject>.)
Public method	AsNested<TResult>(NestedQuerySettings)	Creates a nested query from the given query (Inherited from IDataQuery.)
Public method	AsSingleColumn	Creates a single column query from the given query (Inherited from IDataQuery.)
Public method	AsSubQuery	Modifies the query to be able to be used as a sub-query, e.g. for usage in WHERE A IN ([query]). Ensures single column result, and removes order by from the result. (Inherited from IDataQuery.)
Public method	AsValue	Gets a query expression representing this object as a value (Inherited from IQueryObjectWithValue.)
Public method	BinaryData	Sets whether the binary data should be included to the result (Inherited from IDataQuery<TQuery>.)
Public method	CloneObject	Creates the clone of the object. (Inherited from IQueryObject.)
Public method	Column(String)	Sets the column to select (Inherited from IDataQuerySettings<TQuery>.)
Public method	Column(IQueryColumn)	Sets the column to select (Inherited from IDataQuerySettings<TQuery>.)
Public method	Columns(IEnumerable<String>)	Sets the columns to select (Inherited from IDataQuerySettings<TQuery>.)
Public method	Columns(String[])	Sets the columns to select (Inherited from IDataQuerySettings<TQuery>.)
Public method	Columns(IQueryColumn[])	Sets the columns to select (Inherited from IDataQuerySettings<TQuery>.)
Public method	CombineWithDefaultCulture	The data will be combined with documents in site default culture if not translated to the requested one. This behavior can be used only when a single culture of documents is requested.
Public method	Culture	Filters the data to include only documents translated to given culture(s).
Public method	Default	Ensures default restrictions for the result.
Public method	Distinct	Sets the query to use distinct selection over the given columns (Inherited from IDataQuerySettings<TQuery>.)
Public method	EnsureParameters	Ensures data parameters for the given query (Inherited from IQueryParameters.)
Public method	Except	Gets the intersection of this data query with another query (Inherited from IDataQuery<TQuery>.)
Public method	ExceptGlobal	Filters the data to include only site objects, but not global objects (Inherited from IObjectQuery<TQuery, TObject>.)
Public method	ExcludePath(String[])	Filters the data to exclude documents on given path(s).
Public method	ExcludePath(String, PathTypeEnum)	Filters the data to exclude documents on given path.
Public method	Execute	Executes the current query and returns it's results as a DataSet (Inherited from IDataQuery.)
Public method	ExecuteReader	Executes the current query and returns it's results as a data reader (Inherited from IDataQuery.)
Public method	Expand	Expands the expression by replacing parameters with their values (Inherited from IQueryParameters.)
Public method	ExpandColumns	Expands the columns within this query (Inherited from IDataQuery<TQuery>.)
Public method	FilterDuplicates	Ensures that duplicate document are filtered from the result. This means that linked documents are not retrieved, if there is the original document already included in the results.
Public method	FirstResult	Obsolete. Sets the query as a single object query (i.e. limits the number of fetched rows to 1). (Inherited from IDataQuerySettings<TQuery>.)
Public method	ForEachRow	Executes the given action for each item (DataRow) in the result. Processes the items in batches of the given size. (Inherited from IDataQuery.)
Public method	From	Defines the source of the data (table, view or a nested query) (Inherited from IDataQuery<TQuery>.)
Public method	GetCompleteQueryParameters	Returns query parameter container filled with the complete settings of current query. (Inherited from IDataQuery.)
Public method	GetCompleteSettings	Gets the complete parameters for the query execution (Inherited from IDataQuery.)
Public method	GetExecutingQuery	Gets the query to execute against database (Inherited from IDataQuery.)
Public method	GetExpression	Gets a string expression representing this object (Inherited from IQueryObjectWithValue.)
Public method	GetFullQueryText	Gets the full query text including resolved parameters (Inherited from IDataQuery.)
Public method	GetListResult<T>	Gets the result as a list of values from the first column that the query returns. Excludes null values from the result. (Inherited from IDataQuery.)
Public method	GetScalarResult<T>	Gets the scalar (Inherited from IDataQuery.)
Public method	GetSource	Gets a source for this query (Inherited from IDataQuery.)
Public method	GroupBy	Specifies the columns to group by (Inherited from IDataQuerySettings<TQuery>.)
Public method	HasCompatibleSource	Returns true if the given query is an external source (Inherited from IDataQuery.)
Public method	Having(IWhereCondition[])	Adds the given having conditions to the query. (Inherited from IDataQuerySettings<TQuery>.)
Public method	Having(Action<WhereCondition>)	Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it. (Inherited from IDataQuerySettings<TQuery>.)
Public method	Having(String, Boolean)	Specifies the group by having condition (Inherited from IDataQuerySettings<TQuery>.)
Public method	Changed	Marks the object as changed (Inherited from IQueryObject.)
Public method	CheckPermissions	Ensures that the result will be filtered based on user Read permission.
Public method	InCategory	Ensures that only documents assigned to specified category are retrieved (including all categories on path).
Public method	IncludeDataParameters	Adds the data parameters to the current query parameters (Inherited from IQueryObject.)
Public method	InRelationWith	Ensures that only documents in relationship with a specified document are retrieved.
Public method	Intersect	Gets the intersection of this data query with another query (Inherited from IDataQuery<TQuery>.)
Public method	LatestVersion	Ensures that latest version of the documents is retrieved.
Public method	NestingLevel	Ensures that only documents within specified nesting level are retrieved.
Public method	NewGroupBy	Clears the current group by, reverting the source of data to the original. Note, that this method also resets the existing having condition which is closely bound to the group by. (Inherited from IDataQuerySettings<TQuery>.)
Public method	NewHaving	Clears the current having condition (Inherited from IDataQuerySettings<TQuery>.)
Public method	NewWhere	Clears the current where condition (Inherited from IWhereCondition<TParent>.)
Public method	NextPage	Adjusts the query to a next page, using the current page size. Use in combination with PagedBy and NextPageAvailable to iterate over the data in batches. (Inherited from IDataQuerySettings<TQuery>.)
Public method	NoResults	Sets the where condition to exclude all data from result (Inherited from IWhereCondition<TParent>.)
Public method	NotPaged	Sets up the query to become not paged query and output all results at once. (Inherited from IDataQuerySettings<TQuery>.)
Public method	OnCurrentSite	Filters the data to include only records on the current site.
Public method	OnlyGlobal	Filters the data to include only global objects. (Inherited from IObjectQuery<TQuery, TObject>.)
Public method	OnSite	Filters the data to include only records on the given site. If site binding is defined, filters the global objects by the site ID (Inherited from IObjectQuery<TQuery, TObject>.)
Public method	Or()	Changes the where operator to OR for next where conditions. Use in combination of methods Where... (Inherited from IWhereCondition<TParent>.)
Public method	Or(IWhereCondition)	Adds the given where condition with the OR operator (Inherited from IWhereCondition<TParent>.)
Public method	Or(Action<WhereCondition>)	Adds the given where condition with the OR operator. Creates a new where condition object and runs the setup actions on it. (Inherited from IWhereCondition<TParent>.)
Public method	OrderBy(String[])	Adds the columns to the order by query (Inherited from IDataQuerySettings<TQuery>.)
Public method	OrderBy(OrderDirection, String[])	Adds the columns to the order by query (Inherited from IDataQuerySettings<TQuery>.)
Public method	OrderByAscending	Adds the columns to the order by query to order by the given columns in ascending order (Inherited from IDataQuerySettings<TQuery>.)
Public method	OrderByDefault	Sets the default order by for the query (Inherited from IDataQuery<TQuery>.)
Public method	OrderByDescending	Adds the columns to the order by query to order by the given columns in descending order (Inherited from IDataQuerySettings<TQuery>.)
Public method	Page	Specifies the page to select with given page index and page size. Page number is indexed from 0 (first page) (Inherited from IDataQuerySettings<TQuery>.)
Public method	PagedBy	Sets up the query as a paged query with the given page size. Resets the page index to first page. Use in combination with NextPageAvailable and NextPage to iterate over the data in batches. (Inherited from IDataQuerySettings<TQuery>.)
Public method	Path(String[])	Filters the data to include only documents on given path(s).
Public method	Path(String, PathTypeEnum)	Filters the data to include only documents on given path.
Public method	Published	Ensures that only documents published on a live site are retrieved.
Public method	PublishedVersion	Ensures that published version of the documents is retrieved.
Public method	ReplaceColumn	Replaces the selected column with a new name (Inherited from IDataQuerySettings<TQuery>.)
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	Select<T>	Transforms the current result (Inherited from IDataQuery.)
Public method	Source	Defines the source of the data (table, view or a nested query) (Inherited from IDataQuery<TQuery>.)
Public method	Take	Identity method to make the query expression more readable. Use before the Columns or Page method. Doesn't provide any functionality. (Inherited from IDataQuerySettings<TQuery>.)
Public method	Then	Identity method to make the query expression more readable. Use before the OrderBy method. Doesn't provide any functionality. (Inherited from IDataQuerySettings<TQuery>.)
Public method	TopN	Selects only first top N number of records (Inherited from IDataQuerySettings<TQuery>.)
Public method	ToString	Returns the string representation of the expression, with possibility of expanding parameters (Inherited from IQueryParameters.)
Public method	Union	Gets the union of this data query with another query (Inherited from IDataQuery<TQuery>.)
Public method	UnionAll	Gets the union of this data query with another query without eliminating the duplicities (Inherited from IDataQuery<TQuery>.)
Public method	Where(IWhereCondition[])	Adds the given where conditions to the query (Inherited from IWhereCondition<TParent>.)
Public method	Where(Action<WhereCondition>)	Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it. (Inherited from IWhereCondition<TParent>.)
Public method	Where(String, QueryDataParameters)	Adds the given where condition to the query (Inherited from IWhereCondition<TParent>.)
Public method	Where(String, QueryUnaryOperator)	Adds the given where condition to the query. Matches the column value with an unary operator. (Inherited from IWhereCondition<TParent>.)
Public method	Where(String, QueryOperator, Object)	Adds the given where condition to the query. Matches the column to a given value. (Inherited from IWhereCondition<TParent>.)
Public method	WhereAnyColumn	Matches the given condition on any column with the same type as the given value type. (Inherited from IDataQuery<TQuery>.)
Public method	WhereAnyColumnContains	Adds condition to all items that contain given text in any of the string columns. Performs a SQL substring search on the data. (Inherited from IDataQuery<TQuery>.)
Public method	WhereContains	Adds the condition for a string column to contain some substring (Inherited from IWhereCondition<TParent>.)
Public method	WhereEmpty	Adds the where condition for a null or empty column value (Inherited from IWhereCondition<TParent>.)
Public method	WhereEquals	Adds the given where condition to the query. Matches the column to a given value. (Inherited from IWhereCondition<TParent>.)
Public method	WhereEqualsOrNull	Adds the given where condition to the query. Matches the column to a given value or null value. (Inherited from IWhereCondition<TParent>.)
Public method	WhereExists	Adds where condition with EXISTS and the nested query "EXISTS (...)" (Inherited from IWhereCondition<TParent>.)
Public method	WhereFalse	Adds the where condition for a false column value (boolean column equals false). (Inherited from IWhereCondition<TParent>.)
Public method	WhereID	Adds the where condition to match the ID to the query. In case the column name is not provided or unknown, does not generate where condition. If given ID is invalid, adds the condition to match NULL. (Inherited from IWhereCondition<TParent>.)
Public method	WhereIn(String, IDataQuery)	Adds where condition to the nested query, e.g. "columnName IN (...)" (Inherited from IWhereCondition<TParent>.)
Public method	WhereIn(String, ICollection<Int32>)	Adds where condition to the list of values, e.g. "columnName IN (...)" (Inherited from IWhereCondition<TParent>.)
Public method	WhereLike	Adds the given where condition to the query. Matches the column to a given value using LIKE operator. (Inherited from IWhereCondition<TParent>.)
Public method	WhereNot	Adds the negation of the given where condition (Inherited from IWhereCondition<TParent>.)
Public method	WhereNotContains	Adds the condition for a string column not to contain some substring (Inherited from IWhereCondition<TParent>.)
Public method	WhereNotEmpty	Adds the where condition for a non empty column value (Inherited from IWhereCondition<TParent>.)
Public method	WhereNotExists	Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)" (Inherited from IWhereCondition<TParent>.)
Public method	WhereNotIn(String, IDataQuery)	Adds where condition to the nested query, e.g. "columnName NOT IN (...)" (Inherited from IWhereCondition<TParent>.)
Public method	WhereNotIn(String, ICollection<Int32>)	Adds where condition to the list of values, e.g. "columnName NOT IN (...)" (Inherited from IWhereCondition<TParent>.)
Public method	WhereNotLike	Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator. (Inherited from IWhereCondition<TParent>.)
Public method	WhereNotNull	Adds the where condition for a not null column value (Inherited from IWhereCondition<TParent>.)
Public method	WhereNotStartsWith	Adds the condition for a string column not to start with some prefix (Inherited from IWhereCondition<TParent>.)
Public method	WhereNull	Adds the where condition for a null column value (Inherited from IWhereCondition<TParent>.)
Public method	WhereStartsWith	Adds the condition for a string column to start with some prefix (Inherited from IWhereCondition<TParent>.)
Public method	WhereTrue	Adds the where condition for a true column value (boolean column equals true). (Inherited from IWhereCondition<TParent>.)
Public method	WithCodeName	Sets the where condition for a specific object code name (Inherited from IObjectQuery<TQuery, TObject>.)
Public method	WithComment	Adds the comment to the given query (Inherited from IDataQuerySettings<TQuery>.)
Public method	WithGuid	Sets the where condition for a specific object GUID (Inherited from IObjectQuery<TQuery, TObject>.)
Public method	WithID	Sets the where condition for a specific object ID (Inherited from IObjectQuery<TQuery, TObject>.)
Public method	WithObjectType	Changes the query to use the given object type. Applies the object type condition to the query. The new object type must have the same class name as the original one. (Inherited from IObjectQuery<TQuery, TObject>.)
Public method	WithSettings(AbstractQueryObject)	Applies the given parameters to the query (Inherited from IDataQuery<TQuery>.)
Public method	WithSettings(Action<DataQuerySettings>)	Applies the given parameters to the query (Inherited from IDataQuery<TQuery>.)
Public method	WithSource(DataSet)	Sets the given DataSet as the source of the data query (Inherited from IDataQuery<TQuery>.)
Public method	WithSource(DataQuerySource)	Sets the given source as the source of the data query (Inherited from IDataQuery<TQuery>.)

Extension Methods

	Name	Description
Public Extension Method	FakeExecution	Fakes the execution of a query (Defined by UnitTestExtensions.)
Public Extension Method	GetObjectRelationships	Gets the query for all relationships of the objects that the query represents (Defined by RelationshipsExtensions.)