Click or drag to resize
DocumentQueryBaseTQuery, TObject Class
Predefined query returning given document type.
Inheritance Hierarchy
SystemObject
  CMS.BaseDisposableObject
    CMS.DataEngineAbstractQueryObject
      CMS.DataEngineQueryParametersBaseTQuery
        CMS.DataEngineWhereConditionBaseTQuery
          CMS.DataEngineDataQuerySettingsBaseTQuery
            CMS.DataEngineDataQueryBaseTQuery
              CMS.DataEngineObjectQueryBaseTQuery, TObject
                CMS.DocumentEngineDocumentQueryBaseTQuery, TObject
                  CMS.DocumentEngineDocumentQuery
                  CMS.DocumentEngineDocumentQueryTDocument

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 8.2.23
Syntax
C#
public abstract class DocumentQueryBase<TQuery, TObject> : ObjectQueryBase<TQuery, TObject>, 
	IDocumentQuery<TQuery, TObject>, IObjectQuery<TQuery, TObject>, IDataQuery<TQuery>, 
	IDataQuerySettings<TQuery>, IWhereCondition<TQuery>, IDocumentQuery, IObjectQuery, 
	IDataQuery, IDataQuerySettings, IWhereCondition, IQueryParameters, IDisposable, 
	IQueryObjectWithValue, IQueryObject
where TQuery : new(), DocumentQueryBase<TQuery, TObject>
where TObject : new(), TreeNode

Type Parameters

TQuery
TObject

The DocumentQueryBaseTQuery, TObject type exposes the following members.

Constructors
Methods
  NameDescription
Public methodAddColumn(String)
Adds the additional column to the query
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodAddColumn(IQueryColumn)
Adds the additional column to the query
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodAddColumns(IEnumerableString)
Adds the additional columns to the query
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodAddColumns(String)
Adds the additional columns to the query
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodAddColumns(IQueryColumn)
Adds the additional columns to the query
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodAddFilterColumn
Adds the additional filter column to the query
(Inherited from DataQuerySettingsBaseTQuery.)
Protected methodAddHavingInternal
Adds the given having condition
(Inherited from DataQuerySettingsBaseTQuery.)
Protected methodAddWhereCondition
Adds the given where condition to the final where condition
(Inherited from WhereConditionBaseTParent.)
Protected methodAddWhereConditionInternal
Adds the given where condition
(Inherited from WhereConditionBaseTParent.)
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 WhereConditionBaseTParent.)
Public methodAnd(IWhereCondition)
Adds the given where condition with the AND operator
(Inherited from WhereConditionBaseTParent.)
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 WhereConditionBaseTParent.)
Protected methodAnySettingsDefined
Returns true if the object has any settings defined that influence the resulting query
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodApplyParametersTo
Applies this query parameters to the target object
(Inherited from DataQueryBaseTQuery.)
Public methodApplySettings(AbstractQueryObject)
Applies the given settings to the query
(Inherited from DataQueryBaseTQuery.)
Public methodApplySettings(ActionDataQuerySettings)
Applies the given settings to the query
(Inherited from DataQueryBaseTQuery.)
Public methodAsTNewType
Changes the type of the query to another type
(Inherited from DataQueryBaseTQuery.)
Public methodAsColumn
Converts the query to the query column using this query as nested
(Inherited from DataQueryBaseTQuery.)
Public methodAsIDQuery
Creates an ID query from the given query
(Inherited from DataQueryBaseTQuery.)
Public methodAsMaterializedList
Makes a materialized list from the given query
(Inherited from DataQueryBaseTQuery.)
Public methodAsNested
Creates a nested query from the given query
(Inherited from ObjectQueryBaseTQuery, TObject.)
Public methodAsSingleColumn
Creates a single column query from the given query
(Inherited from DataQueryBaseTQuery.)
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 DataQueryBaseTQuery.)
Public methodAsValue
Gets a query expression representing this object as a value
(Inherited from DataQueryBaseTQuery.)
Public methodBinaryData
Sets whether the binary data should be included to the result
(Inherited from DataQueryBaseTQuery.)
Public methodCallOnDispose
Adds the given action to the list of actions called when the handler object is disposed
(Inherited from DisposableObject.)
Public methodClone
Creates the clone of the object.
(Inherited from QueryParametersBaseTParent.)
Public methodCloneObject
Creates the clone of the object.
(Inherited from QueryParametersBaseTParent.)
Public methodColumn(String)
Sets the column to select
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodColumn(IQueryColumn)
Sets the column to select
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodColumns(IEnumerableString)
Sets the columns to select
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodColumns(String)
Sets the columns to select
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodColumns(IQueryColumn)
Sets the columns to select
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodCombineWithAnyCulture
The data will be combined with documents in any culture if not translated to the requested one(s). When several cultures are required, the order is taken in account as a priority for documents with several matching language versions followed by any other language version. If no culture specified, the highest priority has site preferred culture, second the default culture followed by the rest of site cultures.
Public methodCombineWithDefaultCulture
The data will be combined with documents in site default culture if not translated to the requested one(s). When several cultures are required, the order is taken in account as a priority for documents with several matching language versions.
Public methodCopyPropertiesTo
Copies the properties to the target query.
(Overrides ObjectQueryBaseTQuery, TObjectCopyPropertiesTo(IQueryObject).)
Public methodCreateChild
Creates the child collection based on the given provider
(Inherited from ObjectQueryBaseTQuery, TObject.)
Public methodCulture
Filters the data to include only documents translated to given culture(s).
Protected methodDataSourceChanged
Marks the object as changed when data source changes
(Inherited from DataQueryBaseTQuery.)
Public methodDefault
Ensures default restrictions for the result.
Public methodDispose
Make sure the objects get disposed
(Inherited from DisposableObject.)
Public methodDistinct
Sets the query to use distinct selection over the given columns
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodEnsureParameters
Ensures data parameters for the given query
(Inherited from QueryParametersBaseTParent.)
Public methodExcept
Gets the intersection of this data query with another query
(Inherited from DataQueryBaseTQuery.)
Public methodExceptGlobal
Filters the data to include only site objects, but not global objects
(Inherited from ObjectQueryBaseTQuery, 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 DataQueryBaseTQuery.)
Public methodExecuteReader
Executes the current query and returns it's results as a data reader
(Inherited from DataQueryBaseTQuery.)
Public methodExpand
Expands the expression by replacing parameters with their values
(Inherited from QueryParametersBaseTParent.)
Public methodExpandColumns
Expands the columns within this query
(Inherited from DataQueryBaseTQuery.)
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
Sets the query as a single object query
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodForEachObject
Executes the given action for each item (TObject) in the result. Processes the items in batches of the given size.
(Inherited from ObjectQueryBaseTQuery, TObject.)
Public methodForEachPage
Executes the given action for each page (DataSet) in the results. If the query is not set up as a paged query before calling this method and pageSize is not set, executes the action once with the current results.
(Inherited from DataQueryBaseTQuery.)
Public methodForEachRow
Executes the given action for each item (DataRow) in the result. Processes the items in batches of the given size.
(Inherited from DataQueryBaseTQuery.)
Public methodFrom
Defines the source of the data (table, view or a nested query)
(Inherited from DataQueryBaseTQuery.)
Protected methodGenerateQueryText
Generates query text from the executing query
(Inherited from ObjectQueryBaseTQuery, TObject.)
Protected methodGetAvailableColumns
Gets the list of all available columns for this query
(Overrides DataQueryBaseTQueryGetAvailableColumns.)
Protected methodGetBinaryColumns
Gets the binary columns for this query
(Inherited from DataQueryBaseTQuery.)
Protected methodGetClassName
Gets the class name for current query
(Inherited from ObjectQueryBaseTQuery, TObject.)
Protected methodGetClassStructureInfo
Gets the class structure info for this query
(Inherited from ObjectQueryBaseTQuery, TObject.)
Public methodGetCompleteSettings
Gets the complete parameters for the query execution. The parameters are always a new instance of DataQuerySettings which can be further modified without any impact to the query itself.
(Overrides DataQueryBaseTQueryGetCompleteSettings(IDataQuery).)
Protected methodGetData
Gets data set returned by document query or custom data set. Data set can be modified by calling DocumentEvents.GetData event.
(Overrides ObjectQueryBaseTQuery, TObjectGetData.)
Protected methodGetDataFromDataSource
Executes the current over data source and returns it's results as a DataSet
(Inherited from DataQueryBaseTQuery.)
Protected methodGetDataFromDB
Executes the query using data retrieval through the given info object
(Inherited from ObjectQueryBaseTQuery, TObject.)
Protected methodGetDataSourceName
Gets the unique query source ID
(Inherited from ObjectQueryBaseTQuery, TObject.)
Protected methodGetDefaultOrderBy
Gets the default order by columns
(Inherited from ObjectQueryBaseTQuery, TObject.)
Protected methodGetDefaultSingleColumn
Gets the default single column for the query
(Inherited from DataQueryBaseTQuery.)
Protected methodGetDefaultSource
Gets the default source for this query
(Inherited from DataQueryBaseTQuery.)
Public methodGetEnumerator
Gets the typed enumerator
(Inherited from ObjectQueryBaseTQuery, TObject.)
Public methodGetExecutingQuery
Gets the query to execute against database
(Overrides ObjectQueryBaseTQuery, TObjectGetExecutingQuery(DataQuerySettings).)
Public methodGetExpression
Gets a query expression representing this object as a value
(Inherited from DataQueryBaseTQuery.)
Public methodGetExpressions
Gets the query expressions
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodGetFullQueryText
Gets the full query text including resolved parameters
(Inherited from ObjectQueryBaseTQuery, TObject.)
Protected methodGetIDColumn
Gets the ID column for this query
(Inherited from ObjectQueryBaseTQuery, TObject.)
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 DataQueryBaseTQuery.)
Protected methodGetReaderFromDB
Executes the query
(Inherited from ObjectQueryBaseTQuery, TObject.)
Protected methodGetResults
Gets query results
(Overrides ObjectQueryBaseTQuery, TObjectGetResults(IDataQuery, Int32).)
Public methodGetScalarResultT
Gets the scalar
(Inherited from DataQueryBaseTQuery.)
Protected methodGetTypedResult
Gets typed result
(Overrides ObjectQueryBaseTQuery, TObjectGetTypedResult.)
Protected methodGetWhere(String, QueryOperator, Object)
Gets the where condition for the given column
(Inherited from WhereConditionBaseTParent.)
Protected methodGetWhere(IQueryObjectWithValue, QueryOperator, Object)
Gets the where condition for the given column
(Inherited from WhereConditionBaseTParent.)
Public methodGroupBy
Specifies the columns to group by
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodHasCompatibleSource
Returns true if the given query is an external source
(Inherited from DataQueryBaseTQuery.)
Public methodHasResults
Returns true, if the query returns any results
(Inherited from DataQueryBaseTQuery.)
Public methodHaving(IWhereCondition)
Adds the given having conditions to the query.
(Inherited from DataQuerySettingsBaseTQuery.)
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 DataQuerySettingsBaseTQuery.)
Public methodHaving(String, Boolean)
Specifies the having condition
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodChanged
Marks the object as changed
(Inherited from DataQueryBaseTQuery.)
Public methodCheckPermissions
Ensures that the result will be filtered based on user Read permission.
Protected methodCheckReturnsNoResults
Checks if where condition results in no data
(Overrides WhereConditionBaseTParentCheckReturnsNoResults.)
Public methodImmutable
Makes this object instance is immutable, and next subsequent modification starts with a clone of the object.
(Inherited from QueryParametersBaseTParent.)
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 QueryParametersBaseTParent.)
Protected methodInitFromTypeT
Initializes the query from the given type
(Inherited from ObjectQueryBaseTQuery, TObject.)
Protected methodInitIDQuery
Initializes the ID query
(Inherited from ObjectQueryBaseTQuery, TObject.)
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 DataQueryBaseTQuery.)
Public methodLatestVersion
Ensures that latest version of the documents is retrieved.
Protected methodLoadTotalRecordsNonPaged
Loads the number of total records for an unpaged query
(Inherited from DataQueryBaseTQuery.)
Protected methodLoadTotalRecordsPaged
Loads the number of total records for a paged query
(Inherited from DataQueryBaseTQuery.)
Public methodLock
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from DisposableObject.)
Public methodNestingLevel
Ensures that only documents within specified nesting level are retrieved.
Protected methodNewEmptyQuery
Creates a new empty query
(Inherited from ObjectQueryBaseTQuery, TObject.)
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 DataQuerySettingsBaseTQuery.)
Public methodNewHaving
Clears the current having condition
(Inherited from DataQuerySettingsBaseTQuery.)
Protected methodNewResult
Returns properly typed this
(Inherited from QueryParametersBaseTParent.)
Public methodNewWhere
Clears the current where condition
(Inherited from WhereConditionBaseTParent.)
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 DataQuerySettingsBaseTQuery.)
Protected methodNoColumns
Sets the query to return no columns at all
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodNoResults
Sets the where condition to exclude all data from result
(Inherited from WhereConditionBaseTParent.)
Public methodNotPaged
Sets up the query to become not paged query and output all results at once.
(Inherited from DataQuerySettingsBaseTQuery.)
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 ObjectQueryBaseTQuery, 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
(Overrides ObjectQueryBaseTQuery, TObjectOnSite(SiteInfoIdentifier, Boolean).)
Public methodOr
Changes the where operator to OR for next where conditions. Use in combination of methods Where...
(Inherited from WhereConditionBaseTParent.)
Public methodOr(IWhereCondition)
Adds the given where condition with the OR operator
(Inherited from WhereConditionBaseTParent.)
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 WhereConditionBaseTParent.)
Public methodOrderBy(String)
Adds the columns to the order by query
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodOrderBy(OrderDirection, String)
Adds the columns to the order by query
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodOrderByAscending
Adds the columns to the order by query to order by the given columns in ascending order
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodOrderByDefault
Sets the default order by for the query
(Inherited from DataQueryBaseTQuery.)
Public methodOrderByDescending
Adds the columns to the order by query to order by the given columns in descending order
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodPage
Specifies the page to select with given page index and page size. Page number is indexed from 0 (first page)
(Inherited from DataQuerySettingsBaseTQuery.)
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 DataQuerySettingsBaseTQuery.)
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 latest version of the documents is retrieved.
Public methodReplaceColumn
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBaseTQuery.)
Protected methodReplaceOrderByColumn
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBaseTQuery.)
Protected methodReplaceSelectedColumn
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodReset
Flushes the results but leaves the generated query text unchanged. After the reset, query can be executed again to obtain new data.
(Inherited from DataQueryBaseTQuery.)
Protected methodResetWhereOperator
Resets the where operator to the default value
(Inherited from WhereConditionBaseTParent.)
Protected methodResolveColumns
Resolves the columns in the given list
(Inherited from DataQueryBaseTQuery.)
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 WhereConditionBaseTParent.)
Public methodSelectT
Transforms the current result
(Inherited from DataQueryBaseTQuery.)
Protected methodSetClassName
Gets the class name for current query
(Inherited from DataQueryBaseTQuery.)
Public methodSnapshot
Creates an immutable snapshot of the current query as a base for further evaluation. Doesn't modify the original query in any way.
(Inherited from QueryParametersBaseTParent.)
Public methodSource
Defines the source of the data (table, view or a nested query)
(Inherited from DataQueryBaseTQuery.)
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 DataQuerySettingsBaseTQuery.)
Public methodThen
Identity method to make the query expression more readable. Use before the OrderBy method. Doesn't provide any functionality.
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodTopN
Selects only first top N number of records
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodToString
Returns the string representation of the expression
(Inherited from QueryParametersBaseTParent.)
Public methodToString(Boolean)
Returns the string representation of the expression, with possibility of expanding parameters
(Inherited from ObjectQueryBaseTQuery, TObject.)
Protected methodTypeUpdated
Updates the query class name based on the current status
(Overrides ObjectQueryBaseTQuery, TObjectTypeUpdated.)
Public methodUnion
Gets the union of this data query with another query
(Inherited from DataQueryBaseTQuery.)
Public methodUnionAll
Gets the union of this data query with another query without eliminating the duplicities
(Inherited from DataQueryBaseTQuery.)
Public methodUsing
Adds the given object to the list of the allocated objects to dispose
(Inherited from DisposableObject.)
Public methodWhere(IWhereCondition)
Adds the given where conditions to the query
(Inherited from WhereConditionBaseTParent.)
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 WhereConditionBaseTParent.)
Public methodWhere(String, QueryDataParameters)
Adds the given where condition to the query
(Inherited from WhereConditionBaseTParent.)
Public methodWhere(String, QueryUnaryOperator)
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from WhereConditionBaseTParent.)
Public methodWhere(IQueryObjectWithValue, QueryUnaryOperator)
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from WhereConditionBaseTParent.)
Public methodWhere(String, QueryOperator, Object)
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBaseTParent.)
Public methodWhere(IQueryObjectWithValue, QueryOperator, Object)
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBaseTParent.)
Public methodWhereAnyColumn
Matches the given condition on any column with the same type as the given value type.
(Inherited from DataQueryBaseTQuery.)
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 DataQueryBaseTQuery.)
Public methodWhereContains(String, String)
Adds the condition for a string column to contain some substring
(Inherited from WhereConditionBaseTParent.)
Public methodWhereContains(IQueryObjectWithValue, String)
Adds the condition for a string column to contain some substring
(Inherited from WhereConditionBaseTParent.)
Public methodWhereEmpty
Adds the where condition for a null or empty column value
(Inherited from WhereConditionBaseTParent.)
Public methodWhereEndsWith(String, String)
Adds the condition for a string column to end with some prefix
(Inherited from WhereConditionBaseTParent.)
Public methodWhereEndsWith(IQueryObjectWithValue, String)
Adds the condition for a string expression to end with some prefix
(Inherited from WhereConditionBaseTParent.)
Public methodWhereEquals(String, Object)
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBaseTParent.)
Public methodWhereEquals(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side to the given right side.
(Inherited from WhereConditionBaseTParent.)
Public methodWhereEqualsOrNull
Adds the given where condition to the query. Matches the column to a given value or null value.
(Inherited from WhereConditionBaseTParent.)
Public methodWhereExists(IDataQuery)
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from WhereConditionBaseTParent.)
Protected methodWhereExists(IDataQuery, Boolean)
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from WhereConditionBaseTParent.)
Public methodWhereFalse(String)
Adds the where condition for a false column value (boolean column equals false).
(Inherited from WhereConditionBaseTParent.)
Public methodWhereFalse(IQueryObjectWithValue)
Adds the where condition for a false expression value (boolean expression equals false).
(Inherited from WhereConditionBaseTParent.)
Public methodWhereGreaterOrEquals(String, Object)
Adds the given where condition to the query. Matches the left side which is greater or equal than the right side.
(Inherited from WhereConditionBaseTParent.)
Public methodWhereGreaterOrEquals(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side which is greater or equal than the right side.
(Inherited from WhereConditionBaseTParent.)
Public methodWhereGreaterThan(String, Object)
Adds the given where condition to the query. Matches the left side which is greater than the right side.
(Inherited from WhereConditionBaseTParent.)
Public methodWhereGreaterThan(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side which is greater than the right side.
(Inherited from WhereConditionBaseTParent.)
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 WhereConditionBaseTParent.)
Public methodWhereIn(String, IDataQuery)
Adds where condition to the nested query, e.g. "columnName IN (...)"
(Inherited from WhereConditionBaseTParent.)
Public methodWhereIn(String, IListInt32)
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBaseTParent.)
Protected methodWhereIn(String, IDataQuery, Boolean)
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBaseTParent.)
Protected methodWhereIn(String, IListInt32, Boolean)
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBaseTParent.)
Public methodWhereLessOrEquals(String, Object)
Adds the given where condition to the query. Matches the left side which is less or equal than the right side.
(Inherited from WhereConditionBaseTParent.)
Public methodWhereLessOrEquals(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side which is less or equal than the right side.
(Inherited from WhereConditionBaseTParent.)
Public methodWhereLessThan(String, Object)
Adds the given where condition to the query. Matches the left side which is less than the right side.
(Inherited from WhereConditionBaseTParent.)
Public methodWhereLessThan(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side which is less than the right side.
(Inherited from WhereConditionBaseTParent.)
Public methodWhereLike(String, String)
Adds the given where condition to the query. Matches the column to a given value using LIKE operator.
(Inherited from WhereConditionBaseTParent.)
Public methodWhereLike(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side and right side using LIKE operator.
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNot
Adds the negation of the given where condition
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNotContains(String, String)
Adds the condition for a string column not to contain some substring
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNotContains(IQueryObjectWithValue, String)
Adds the condition for a string column not to contain some substring
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNotEmpty
Adds the where condition for a non empty column value
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNotEndsWith(String, String)
Adds the condition for a string column not to end with some prefix
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNotEndsWith(IQueryObjectWithValue, String)
Adds the condition for a string column not to end with some prefix
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNotEquals(String, Object)
Adds the given where condition to the query. Matches the column which is not equal to a given value.
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNotEquals(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side which is not equal to the right side.
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNotExists
Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)"
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNotIn(String, IDataQuery)
Adds where condition to the nested query, e.g. "columnName NOT IN (...)"
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNotIn(String, IListInt32)
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNotLike(String, String)
Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator.
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNotLike(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side and right side using NOT LIKE operator.
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNotNull(String)
Adds the where condition for a not null column value
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNotNull(IQueryObjectWithValue)
Adds the where condition for a not null expression value
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNotStartsWith(String, String)
Adds the condition for a string column not to start with some prefix
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNotStartsWith(IQueryObjectWithValue, String)
Adds the condition for a string column not to start with some prefix
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNull(String)
Adds the where condition for a null column value
(Inherited from WhereConditionBaseTParent.)
Public methodWhereNull(IQueryObjectWithValue)
Adds the where condition for a null expression value
(Inherited from WhereConditionBaseTParent.)
Public methodWhereStartsWith(String, String)
Adds the condition for a string column to start with some prefix
(Inherited from WhereConditionBaseTParent.)
Public methodWhereStartsWith(IQueryObjectWithValue, String)
Adds the condition for a string column to start with some prefix
(Inherited from WhereConditionBaseTParent.)
Public methodWhereTrue(String)
Adds the where condition for a true column value (boolean column equals true).
(Inherited from WhereConditionBaseTParent.)
Public methodWhereTrue(IQueryObjectWithValue)
Adds the where condition for a true expression value (boolean expression equals true).
(Inherited from WhereConditionBaseTParent.)
Public methodWithCodeName
Sets the where condition for a specific object code name
(Inherited from ObjectQueryBaseTQuery, TObject.)
Public methodWithComment
Adds the comment to the given query
(Inherited from DataQuerySettingsBaseTQuery.)
Public methodWithGuid
Sets the where condition for a specific object GUID
(Inherited from ObjectQueryBaseTQuery, TObject.)
Public methodWithID
Sets the where condition for a specific object ID
(Inherited from ObjectQueryBaseTQuery, 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 ObjectQueryBaseTQuery, TObject.)
Public methodWithSettings(AbstractQueryObject)
Applies the given parameters to the query
(Inherited from DataQueryBaseTQuery.)
Public methodWithSettings(ActionDataQuerySettings)
Applies the given parameters to the query
(Inherited from DataQueryBaseTQuery.)
Public methodWithSource(DataSet)
Sets the given DataSet as the source of the data query
(Inherited from DataQueryBaseTQuery.)
Public methodWithSource(TObject)
Sets the given DataSet as the source of the data query
(Inherited from ObjectQueryBaseTQuery, TObject.)
Public methodWithSource(DataQuerySource)
Sets the given source as the source of the data query
(Inherited from DataQueryBaseTQuery.)
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodFakeExecution
Fakes the execution of a query
(Defined by UnitTestExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetObjectRelationships
Gets the query for all relationships of the objects that the query represents
(Defined by RelationshipsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
Properties
  NameDescription
Public propertyAllowMaterialization
If true, the query allows materialization
(Inherited from DataQueryBaseTQuery.)
Public propertyClassName
Class name
(Inherited from DataQueryBaseTQuery.)
Protected propertyConnectionStringForced
If true, the connection string was set explicitly
(Inherited from DataQueryBaseTQuery.)
Public propertyConnectionStringName
Connection string name
(Inherited from DataQueryBaseTQuery.)
Public propertyCount
Number of total items in the collection
(Inherited from DataQueryBaseTQuery.)
Public propertyCustomQueryText
Custom query text
(Inherited from DataQueryBaseTQuery.)
Public propertyDataSource
Data source that provides the query data. If not set, the query queries the database directly
(Inherited from DataQueryBaseTQuery.)
Public propertyDataSourceName
Gets the unique query source ID
(Inherited from DataQueryBaseTQuery.)
Public propertyDefaultOrderByColumns
Default order by columns used in case if needed, and order by is not specified
(Inherited from DataQueryBaseTQuery.)
Public propertyDefaultSourceExpression
Default source of the query in case source is not defined
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertyDisposeUsedObjects
Disposes the objects that were used as parameters for this query
(Inherited from WhereConditionBaseTParent.)
Protected propertyDocument
Document instance of the specified type.
Public propertyElementType
Returns the element type.
(Inherited from ObjectQueryBaseTQuery, TObject.)
Public propertyExpression
Query expression
(Inherited from ObjectQueryBaseTQuery, TObject.)
Public propertyFilterColumns
List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertyFirstObject
DataSet with the result
(Inherited from ObjectQueryBaseTQuery, TObject.)
Protected propertyForceOrderBy
If true, the order by should be forced in the process of execution
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertyFullQueryName
Represents a full query name of the query
(Overrides DataQueryBaseTQueryFullQueryName.)
Public propertyGroupByColumns
List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertyHasDataSource
Returns true if the query has specific data source
(Inherited from DataQueryBaseTQuery.)
Public propertyHasGroupBy
Returns true if the given query has group by set
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertyHavingCondition
Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertyHavingIsComplex
Returns true if the given having condition is a complex condition
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertyHavingIsEmpty
Returns true if the having condition is empty
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertyIncludeBinaryData
If true, the query includes the object binary data. Default is true
(Inherited from DataQueryBaseTQuery.)
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 DataQueryBaseTQuery.)
Protected propertyIsImmutable
If true, this object instance is immutable, and next subsequent modification starts with a clone of the object.
(Inherited from QueryParametersBaseTParent.)
Public propertyIsNested
Indicates that this query is part of multi query
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertyIsOffline
Returns true if the given collection is offline (disconnected from the database)
(Inherited from ObjectQueryBaseTQuery, TObject.)
Public propertyIsPagedQuery
Returns true if the query has the paging enabled
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertyIsSubQuery
If true, the query is a sub-query used in another query
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertyMaxRecords
Maximum number of results to return (use for paging together with Offset)
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertyName
Object name, empty by default
(Inherited from ObjectQueryBaseTQuery, TObject.)
Public propertyNextPageAvailable
Returns true if the next page is available.
(Inherited from DataQueryBaseTQuery.)
Protected propertyObject
Object instance of the specified type.
(Inherited from ObjectQueryBaseTQuery, TObject.)
Public propertyObjectType
Returns the object type of the objects stored within the collection.
(Inherited from ObjectQueryBaseTQuery, TObject.)
Public propertyOffset
Index of the first record to return (use for paging together with MaxRecords)
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertyOrderByColumns
List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertyParameters
Query data parameters
(Inherited from QueryParametersBaseTParent.)
Public propertyProperties
Document query properties.
Public propertyProvider
Query provider
(Inherited from ObjectQueryBaseTQuery, TObject.)
Public propertyQueryName
Query name
(Inherited from DataQueryBaseTQuery.)
Public propertyQueryText
Query text
(Inherited from DataQueryBaseTQuery.)
Public propertyResult
DataSet with the result
(Inherited from DataQueryBaseTQuery.)
Public propertyReturnsNoResults
Returns true if query doesn't return any results
(Inherited from WhereConditionBaseTParent.)
Public propertyReturnsSingleColumn
Returns true if the query returns single column
(Inherited from DataQueryBaseTQuery.)
Public propertySelectColumns Obsolete.
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertySelectColumnsList
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertySelectDistinct
If set to true, returns only distinct (different) values.
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertySourceExpression
Source of the query
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertySupportsReader
Returns true if the query supports data reader
(Inherited from DataQueryBaseTQuery.)
Public propertyTables
Collection of the result tables
(Inherited from DataQueryBaseTQuery.)
Public propertyTopNRecords
If set, selects only first top N number of records
(Inherited from DataQuerySettingsBaseTQuery.)
Public propertyTotalRecords
Gets the number of total records when paging is used. Gets updated once the query executes
(Inherited from DataQueryBaseTQuery.)
Public propertyTypedResult
Typed result
(Inherited from ObjectQueryBaseTQuery, TObject.)
Public propertyTypeInfo
Type info of the specified type
(Inherited from ObjectQueryBaseTQuery, TObject.)
Protected propertyUseObjectQuery
If true, the object query is used as default, otherwise, standard DataQuery is used
(Inherited from ObjectQueryBaseTQuery, TObject.)
Public propertyUseObjectTypeCondition
If true, the query uses the object type condition.
(Inherited from ObjectQueryBaseTQuery, TObject.)
Protected propertyWhereBuilder
Where condition builder
(Inherited from WhereConditionBaseTParent.)
Public propertyWhereCondition
Where condition on the data, e.g. "DocumentName = 'ABC'"
(Inherited from WhereConditionBaseTParent.)
Public propertyWhereIsComplex
Returns true if the given where condition contains compound conditions, e. g. "A > 1 AND B = 5"
(Inherited from WhereConditionBaseTParent.)
Public propertyWhereIsEmpty
Returns true if the where condition is empty
(Inherited from WhereConditionBaseTParent.)
Protected propertyWhereOperator
Operator used for adding where condition. Default is AND
(Inherited from WhereConditionBaseTParent.)
Top
See Also