Click or drag to resize
IDocumentQueryTQuery, 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
C#
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 IDocumentQueryTQuery, TObject type exposes the following members.

Properties
  NameDescription
Public propertyAllowMaterialization
If true, the query allows materialization
(Inherited from IDataQuery.)
Public propertyClassName
Class name
(Inherited from IDataQuery.)
Public propertyConnectionStringName
Query connection string name
(Inherited from IDataQuery.)
Public propertyCount
Number of actual records retrieved from the database
(Inherited from IDataQuery.)
Public propertyCustomQueryText
Custom query text
(Inherited from IDataQuery.)
Public propertyDataSource
Data source that provides the query data. If not set, the query queries the database directly
(Inherited from IDataQuery.)
Public propertyDataSourceName
Data source identifier that represents the location from which the data are obtained.
(Inherited from IWhereCondition.)
Public propertyDefaultOrderByColumns
Default order by columns used in case if needed, and order by is not specified
(Inherited from IDataQuery.)
Public propertyDefaultQuerySource
Default source of the query in case source is not defined
(Inherited from IDataQuerySettings.)
Public propertyDefaultSourceExpression Obsolete.
Default source of the query in case source is not defined
(Inherited from IDataQuerySettings.)
Public propertyFilterColumns
List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"
(Inherited from IDataQuerySettings.)
Public propertyFirstObject
Returns first object from the query result DataSet. The property does not limit the actual number of fetched rows.
(Inherited from IObjectQueryTQuery, TObject.)
Public propertyGroupByColumns
List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
(Inherited from IDataQuerySettings.)
Public propertyHasDataSource
Returns true if the query has specific data source
(Inherited from IDataQuery.)
Public propertyHasGroupBy
Returns true if the given query has group by set
(Inherited from IDataQuerySettings.)
Public propertyHavingCondition
Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
(Inherited from IDataQuerySettings.)
Public propertyIncludeBinaryData
If true, the query includes the object binary data
(Inherited from IDataQuery.)
Public propertyIsCombinedQuery
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 propertyIsNested
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 propertyIsPagedQuery
Returns true if the query has the paging enabled
(Inherited from IDataQuerySettings.)
Public propertyIsSubQuery
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 propertyMaxRecords
Maximum number of results to return (use for paging together with Offset)
(Inherited from IDataQuerySettings.)
Public propertyName
Object name, empty by default
(Inherited from IQueryObject.)
Public propertyObjectType
Returns the object type of the objects stored within the collection.
(Inherited from IObjectQuery.)
Public propertyOffset
Index of the first record to return (use for paging together with MaxRecords)
(Inherited from IDataQuerySettings.)
Public propertyOrderByColumns
List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"
(Inherited from IDataQuerySettings.)
Public propertyParameters
Query data parameters
(Inherited from IQueryObject.)
Public propertyProperties
Document query parameters.
(Inherited from IDocumentQuery.)
Public propertyQueryName
Query name
(Inherited from IDataQuery.)
Public propertyQuerySource
Source of the query
(Inherited from IDataQuerySettings.)
Public propertyQueryText
Query text
(Inherited from IDataQuery.)
Public propertyResult
DataSet with the result
(Inherited from IDataQuery.)
Public propertyReturnsSingleColumn
Returns true if the query returns single column
(Inherited from IDataQuery.)
Public propertySelectColumnsList
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from IDataQuerySettings.)
Public propertySelectDistinct
If set to true, returns only distinct (different) values.
(Inherited from IDataQuerySettings.)
Public propertySourceExpression Obsolete.
Source of the query
(Inherited from IDataQuerySettings.)
Public propertySupportsReader
Returns true if the query supports data reader
(Inherited from IDataQuery.)
Public propertyTables
Collection of the result tables
(Inherited from IDataQuery.)
Public propertyTopNRecords
If set, selects only first top N number of records
(Inherited from IDataQuerySettings.)
Public propertyTotalExpression
Total items expression. When defined, used instead default total items for a paged query.
(Inherited from IDataQuerySettings.)
Public propertyTotalRecords
Gets the number of total records when paging is used. Gets updated once the query executes
(Inherited from IDataQuery.)
Public propertyTypedResult
Typed result
(Inherited from IObjectQueryTQuery, TObject.)
Public propertyUseObjectTypeCondition
If true, the query uses the object type condition.
(Inherited from IObjectQuery.)
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.)
Public propertyWhereIsEmpty
Returns true if the where condition is empty
(Inherited from IWhereCondition.)
Top
Methods
  NameDescription
Public methodAddColumn(String)
Adds the additional column to the query
(Inherited from IDataQuerySettingsTQuery.)
Public methodAddColumn(IQueryColumn)
Adds the additional column to the query
(Inherited from IDataQuerySettingsTQuery.)
Public methodAddColumns(IEnumerableString)
Adds the additional columns to the query
(Inherited from IDataQuerySettingsTQuery.)
Public methodAddColumns(String)
Adds the additional columns to the query
(Inherited from IDataQuerySettingsTQuery.)
Public methodAddColumns(IQueryColumn)
Adds the additional columns to the query
(Inherited from IDataQuerySettingsTQuery.)
Public methodAll
Ensures that there is no restriction applied for the result.
Public methodAllCultures
Ensures that all culture versions of the documents are retrieved.
Public methodAnd
Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where...
(Inherited from IWhereConditionTParent.)
Public methodAnd(IWhereCondition)
Adds the given where condition with the AND operator
(Inherited from IWhereConditionTParent.)
Public methodAnd(ActionWhereCondition)
Adds the given where condition with the AND operator. Creates a new where condition object and runs the setup actions on it.
(Inherited from IWhereConditionTParent.)
Public methodApplyParametersTo
Applies this where condition to the target object
(Inherited from IQueryParameters.)
Public methodApplySettings(AbstractQueryObject)
Applies the given settings to the query
(Inherited from IDataQuery.)
Public methodApplySettings(ActionDataQuerySettings)
Applies the given settings to the query
(Inherited from IDataQuery.)
Public methodAsT
Changes the type of the query to another type
(Inherited from IDataQuery.)
Public methodAsIDQuery
Creates an ID query from the given query
(Inherited from IDataQuery.)
Public methodAsMaterializedList
Makes a materialized list from the given query
(Inherited from IDataQuery.)
Public methodAsNested
Creates a nested query from the given query
(Inherited from IObjectQueryTQuery, TObject.)
Public methodAsNestedTResult(NestedQuerySettings)
Creates a nested query from the given query
(Inherited from IDataQuery.)
Public methodAsSingleColumn
Creates a single column query from the given query
(Inherited from IDataQuery.)
Public methodAsSubQuery
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 methodAsValue
Gets a query expression representing this object as a value
(Inherited from IQueryObjectWithValue.)
Public methodBinaryData
Sets whether the binary data should be included to the result
(Inherited from IDataQueryTQuery.)
Public methodCloneObject
Creates the clone of the object.
(Inherited from IQueryObject.)
Public methodColumn(String)
Sets the column to select
(Inherited from IDataQuerySettingsTQuery.)
Public methodColumn(IQueryColumn)
Sets the column to select
(Inherited from IDataQuerySettingsTQuery.)
Public methodColumns(IEnumerableString)
Sets the columns to select
(Inherited from IDataQuerySettingsTQuery.)
Public methodColumns(String)
Sets the columns to select
(Inherited from IDataQuerySettingsTQuery.)
Public methodColumns(IQueryColumn)
Sets the columns to select
(Inherited from IDataQuerySettingsTQuery.)
Public methodCombineWithDefaultCulture
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 methodCulture
Filters the data to include only documents translated to given culture(s).
Public methodDefault
Ensures default restrictions for the result.
Public methodDistinct
Sets the query to use distinct selection over the given columns
(Inherited from IDataQuerySettingsTQuery.)
Public methodEnsureParameters
Ensures data parameters for the given query
(Inherited from IQueryParameters.)
Public methodExcept
Gets the intersection of this data query with another query
(Inherited from IDataQueryTQuery.)
Public methodExceptGlobal
Filters the data to include only site objects, but not global objects
(Inherited from IObjectQueryTQuery, TObject.)
Public methodExcludePath(String)
Filters the data to exclude documents on given path(s).
Public methodExcludePath(String, PathTypeEnum)
Filters the data to exclude documents on given path.
Public methodExecute
Executes the current query and returns it's results as a DataSet
(Inherited from IDataQuery.)
Public methodExecuteReader
Executes the current query and returns it's results as a data reader
(Inherited from IDataQuery.)
Public methodExpand
Expands the expression by replacing parameters with their values
(Inherited from IQueryParameters.)
Public methodExpandColumns
Expands the columns within this query
(Inherited from IDataQueryTQuery.)
Public methodFilterDuplicates
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 methodFirstResult Obsolete.
Sets the query as a single object query (i.e. limits the number of fetched rows to 1).
(Inherited from IDataQuerySettingsTQuery.)
Public methodForEachRow
Executes the given action for each item (DataRow) in the result. Processes the items in batches of the given size.
(Inherited from IDataQuery.)
Public methodFrom
Defines the source of the data (table, view or a nested query)
(Inherited from IDataQueryTQuery.)
Public methodGetCompleteQueryParameters
Returns query parameter container filled with the complete settings of current query.
(Inherited from IDataQuery.)
Public methodGetCompleteSettings
Gets the complete parameters for the query execution
(Inherited from IDataQuery.)
Public methodGetExecutingQuery
Gets the query to execute against database
(Inherited from IDataQuery.)
Public methodGetExpression
Gets a string expression representing this object
(Inherited from IQueryObjectWithValue.)
Public methodGetFullQueryText
Gets the full query text including resolved parameters
(Inherited from IDataQuery.)
Public methodGetListResultT
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 methodGetScalarResultT
Gets the scalar
(Inherited from IDataQuery.)
Public methodGetSource
Gets a source for this query
(Inherited from IDataQuery.)
Public methodGroupBy
Specifies the columns to group by
(Inherited from IDataQuerySettingsTQuery.)
Public methodHasCompatibleSource
Returns true if the given query is an external source
(Inherited from IDataQuery.)
Public methodHaving(IWhereCondition)
Adds the given having conditions to the query.
(Inherited from IDataQuerySettingsTQuery.)
Public methodHaving(ActionWhereCondition)
Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it.
(Inherited from IDataQuerySettingsTQuery.)
Public methodHaving(String, Boolean)
Specifies the group by having condition
(Inherited from IDataQuerySettingsTQuery.)
Public methodChanged
Marks the object as changed
(Inherited from IQueryObject.)
Public methodCheckPermissions
Ensures that the result will be filtered based on user Read permission.
Public methodInCategory
Ensures that only documents assigned to specified category are retrieved (including all categories on path).
Public methodIncludeDataParameters
Adds the data parameters to the current query parameters
(Inherited from IQueryObject.)
Public methodInRelationWith
Ensures that only documents in relationship with a specified document are retrieved.
Public methodIntersect
Gets the intersection of this data query with another query
(Inherited from IDataQueryTQuery.)
Public methodLatestVersion
Ensures that latest version of the documents is retrieved.
Public methodNestingLevel
Ensures that only documents within specified nesting level are retrieved.
Public methodNewGroupBy
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 IDataQuerySettingsTQuery.)
Public methodNewHaving
Clears the current having condition
(Inherited from IDataQuerySettingsTQuery.)
Public methodNewWhere
Clears the current where condition
(Inherited from IWhereConditionTParent.)
Public methodNextPage
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 IDataQuerySettingsTQuery.)
Public methodNoResults
Sets the where condition to exclude all data from result
(Inherited from IWhereConditionTParent.)
Public methodNotPaged
Sets up the query to become not paged query and output all results at once.
(Inherited from IDataQuerySettingsTQuery.)
Public methodOnCurrentSite
Filters the data to include only records on the current site.
Public methodOnlyGlobal
Filters the data to include only global objects.
(Inherited from IObjectQueryTQuery, TObject.)
Public methodOnSite
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 IObjectQueryTQuery, TObject.)
Public methodOr
Changes the where operator to OR for next where conditions. Use in combination of methods Where...
(Inherited from IWhereConditionTParent.)
Public methodOr(IWhereCondition)
Adds the given where condition with the OR operator
(Inherited from IWhereConditionTParent.)
Public methodOr(ActionWhereCondition)
Adds the given where condition with the OR operator. Creates a new where condition object and runs the setup actions on it.
(Inherited from IWhereConditionTParent.)
Public methodOrderBy(String)
Adds the columns to the order by query
(Inherited from IDataQuerySettingsTQuery.)
Public methodOrderBy(OrderDirection, String)
Adds the columns to the order by query
(Inherited from IDataQuerySettingsTQuery.)
Public methodOrderByAscending
Adds the columns to the order by query to order by the given columns in ascending order
(Inherited from IDataQuerySettingsTQuery.)
Public methodOrderByDefault
Sets the default order by for the query
(Inherited from IDataQueryTQuery.)
Public methodOrderByDescending
Adds the columns to the order by query to order by the given columns in descending order
(Inherited from IDataQuerySettingsTQuery.)
Public methodPage
Specifies the page to select with given page index and page size. Page number is indexed from 0 (first page)
(Inherited from IDataQuerySettingsTQuery.)
Public methodPagedBy
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 IDataQuerySettingsTQuery.)
Public methodPath(String)
Filters the data to include only documents on given path(s).
Public methodPath(String, PathTypeEnum)
Filters the data to include only documents on given path.
Public methodPublished
Ensures that only documents published on a live site are retrieved.
Public methodPublishedVersion
Ensures that published version of the documents is retrieved.
Public methodReplaceColumn
Replaces the selected column with a new name
(Inherited from IDataQuerySettingsTQuery.)
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 methodSelectT
Transforms the current result
(Inherited from IDataQuery.)
Public methodSource
Defines the source of the data (table, view or a nested query)
(Inherited from IDataQueryTQuery.)
Public methodTake
Identity method to make the query expression more readable. Use before the Columns or Page method. Doesn't provide any functionality.
(Inherited from IDataQuerySettingsTQuery.)
Public methodThen
Identity method to make the query expression more readable. Use before the OrderBy method. Doesn't provide any functionality.
(Inherited from IDataQuerySettingsTQuery.)
Public methodTopN
Selects only first top N number of records
(Inherited from IDataQuerySettingsTQuery.)
Public methodToString
Returns the string representation of the expression, with possibility of expanding parameters
(Inherited from IQueryParameters.)
Public methodUnion
Gets the union of this data query with another query
(Inherited from IDataQueryTQuery.)
Public methodUnionAll
Gets the union of this data query with another query without eliminating the duplicities
(Inherited from IDataQueryTQuery.)
Public methodWhere(IWhereCondition)
Adds the given where conditions to the query
(Inherited from IWhereConditionTParent.)
Public methodWhere(ActionWhereCondition)
Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it.
(Inherited from IWhereConditionTParent.)
Public methodWhere(String, QueryDataParameters)
Adds the given where condition to the query
(Inherited from IWhereConditionTParent.)
Public methodWhere(String, QueryUnaryOperator)
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from IWhereConditionTParent.)
Public methodWhere(String, QueryOperator, Object)
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from IWhereConditionTParent.)
Public methodWhereAnyColumn
Matches the given condition on any column with the same type as the given value type.
(Inherited from IDataQueryTQuery.)
Public methodWhereAnyColumnContains
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 IDataQueryTQuery.)
Public methodWhereContains
Adds the condition for a string column to contain some substring
(Inherited from IWhereConditionTParent.)
Public methodWhereEmpty
Adds the where condition for a null or empty column value
(Inherited from IWhereConditionTParent.)
Public methodWhereEquals
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from IWhereConditionTParent.)
Public methodWhereEqualsOrNull
Adds the given where condition to the query. Matches the column to a given value or null value.
(Inherited from IWhereConditionTParent.)
Public methodWhereExists
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from IWhereConditionTParent.)
Public methodWhereFalse
Adds the where condition for a false column value (boolean column equals false).
(Inherited from IWhereConditionTParent.)
Public methodWhereID
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 IWhereConditionTParent.)
Public methodWhereIn(String, IDataQuery)
Adds where condition to the nested query, e.g. "columnName IN (...)"
(Inherited from IWhereConditionTParent.)
Public methodWhereIn(String, ICollectionInt32)
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from IWhereConditionTParent.)
Public methodWhereLike
Adds the given where condition to the query. Matches the column to a given value using LIKE operator.
(Inherited from IWhereConditionTParent.)
Public methodWhereNot
Adds the negation of the given where condition
(Inherited from IWhereConditionTParent.)
Public methodWhereNotContains
Adds the condition for a string column not to contain some substring
(Inherited from IWhereConditionTParent.)
Public methodWhereNotEmpty
Adds the where condition for a non empty column value
(Inherited from IWhereConditionTParent.)
Public methodWhereNotExists
Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)"
(Inherited from IWhereConditionTParent.)
Public methodWhereNotIn(String, IDataQuery)
Adds where condition to the nested query, e.g. "columnName NOT IN (...)"
(Inherited from IWhereConditionTParent.)
Public methodWhereNotIn(String, ICollectionInt32)
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
(Inherited from IWhereConditionTParent.)
Public methodWhereNotLike
Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator.
(Inherited from IWhereConditionTParent.)
Public methodWhereNotNull
Adds the where condition for a not null column value
(Inherited from IWhereConditionTParent.)
Public methodWhereNotStartsWith
Adds the condition for a string column not to start with some prefix
(Inherited from IWhereConditionTParent.)
Public methodWhereNull
Adds the where condition for a null column value
(Inherited from IWhereConditionTParent.)
Public methodWhereStartsWith
Adds the condition for a string column to start with some prefix
(Inherited from IWhereConditionTParent.)
Public methodWhereTrue
Adds the where condition for a true column value (boolean column equals true).
(Inherited from IWhereConditionTParent.)
Public methodWithCodeName
Sets the where condition for a specific object code name
(Inherited from IObjectQueryTQuery, TObject.)
Public methodWithComment
Adds the comment to the given query
(Inherited from IDataQuerySettingsTQuery.)
Public methodWithGuid
Sets the where condition for a specific object GUID
(Inherited from IObjectQueryTQuery, TObject.)
Public methodWithID
Sets the where condition for a specific object ID
(Inherited from IObjectQueryTQuery, TObject.)
Public methodWithObjectType
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 IObjectQueryTQuery, TObject.)
Public methodWithSettings(AbstractQueryObject)
Applies the given parameters to the query
(Inherited from IDataQueryTQuery.)
Public methodWithSettings(ActionDataQuerySettings)
Applies the given parameters to the query
(Inherited from IDataQueryTQuery.)
Public methodWithSource(DataSet)
Sets the given DataSet as the source of the data query
(Inherited from IDataQueryTQuery.)
Public methodWithSource(DataQuerySource)
Sets the given source as the source of the data query
(Inherited from IDataQueryTQuery.)
Top
Extension Methods
  NameDescription
Public Extension MethodFakeExecution
Fakes the execution of a query
(Defined by UnitTestExtensions.)
Public Extension MethodGetObjectRelationships
Gets the query for all relationships of the objects that the query represents
(Defined by RelationshipsExtensions.)
Top
See Also