IDocumentQueryTQuery, TObject Methods |
The IDocumentQueryTQuery, TObject generic type exposes the following members.
Name | Description | |
---|---|---|
AddColumn(String) |
Adds the additional column to the query
(Inherited from IDataQuerySettingsTQuery.) | |
AddColumn(IQueryColumn) |
Adds the additional column to the query
(Inherited from IDataQuerySettingsTQuery.) | |
AddColumns(IEnumerableString) |
Adds the additional columns to the query
(Inherited from IDataQuerySettingsTQuery.) | |
AddColumns(String) |
Adds the additional columns to the query
(Inherited from IDataQuerySettingsTQuery.) | |
AddColumns(IQueryColumn) |
Adds the additional columns to the query
(Inherited from IDataQuerySettingsTQuery.) | |
All |
Ensures that there is no restriction applied for the result.
| |
AllCultures |
Ensures that all culture versions of the documents are retrieved.
| |
And |
Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where...
(Inherited from IWhereConditionTParent.) | |
And(IWhereCondition) |
Adds the given where condition with the AND operator
(Inherited from IWhereConditionTParent.) | |
And(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.) | |
ApplyParametersTo |
Applies this where condition to the target object
(Inherited from IQueryParameters.) | |
ApplySettings(AbstractQueryObject) |
Applies the given settings to the query
(Inherited from IDataQuery.) | |
ApplySettings(ActionDataQuerySettings) |
Applies the given settings to the query
(Inherited from IDataQuery.) | |
AsT |
Changes the type of the query to another type
(Inherited from IDataQuery.) | |
AsIDQuery |
Creates an ID query from the given query
(Inherited from IDataQuery.) | |
AsMaterializedList |
Makes a materialized list from the given query
(Inherited from IDataQuery.) | |
AsNested |
Creates a nested query from the given query
(Inherited from IObjectQueryTQuery, TObject.) | |
AsNestedTResult(NestedQuerySettings) |
Creates a nested query from the given query
(Inherited from IDataQuery.) | |
AsSingleColumn |
Creates a single column query from the given query
(Inherited from IDataQuery.) | |
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.) | |
AsValue |
Gets a query expression representing this object as a value
(Inherited from IQueryObjectWithValue.) | |
BinaryData |
Sets whether the binary data should be included to the result
(Inherited from IDataQueryTQuery.) | |
CloneObject |
Creates the clone of the object.
(Inherited from IQueryObject.) | |
Column(String) |
Sets the column to select
(Inherited from IDataQuerySettingsTQuery.) | |
Column(IQueryColumn) |
Sets the column to select
(Inherited from IDataQuerySettingsTQuery.) | |
Columns(IEnumerableString) |
Sets the columns to select
(Inherited from IDataQuerySettingsTQuery.) | |
Columns(String) |
Sets the columns to select
(Inherited from IDataQuerySettingsTQuery.) | |
Columns(IQueryColumn) |
Sets the columns to select
(Inherited from IDataQuerySettingsTQuery.) | |
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.
| |
CopyPropertiesTo |
Copies the properties to the target query.
(Inherited from IQueryParameters.) | |
Culture |
Filters the data to include only documents translated to given culture(s).
| |
Default |
Ensures default restrictions for the result.
| |
Distinct |
Sets the query to use distinct selection over the given columns
(Inherited from IDataQuerySettingsTQuery.) | |
EnsureParameters |
Ensures data parameters for the given query
(Inherited from IQueryParameters.) | |
Except |
Gets the intersection of this data query with another query
(Inherited from IDataQueryTQuery.) | |
ExceptGlobal |
Filters the data to include only site objects, but not global objects
(Inherited from IObjectQueryTQuery, TObject.) | |
ExcludePath(String) |
Filters the data to exclude documents on given path(s).
| |
ExcludePath(String, PathTypeEnum) |
Filters the data to exclude documents on given path.
| |
Execute |
Executes the current query and returns it's results as a DataSet
(Inherited from IDataQuery.) | |
ExecuteReader |
Executes the current query and returns it's results as a data reader
(Inherited from IDataQuery.) | |
Expand |
Expands the expression by replacing parameters with their values
(Inherited from IQueryParameters.) | |
ExpandColumns |
Expands the columns within this query
(Inherited from IDataQueryTQuery.) | |
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.
| |
ForEachRow |
Executes the given action for each item (DataRow) in the result. Processes the items in batches of the given size.
(Inherited from IDataQuery.) | |
From |
Defines the source of the data (table, view or a nested query)
(Inherited from IDataQueryTQuery.) | |
GetCompleteQueryParameters |
Returns query parameter container filled with the complete settings of current query.
(Inherited from IDataQuery.) | |
GetCompleteSettings |
Gets the complete parameters for the query execution
(Inherited from IDataQuery.) | |
GetExecutingQuery |
Gets the query to execute against database
(Inherited from IDataQuery.) | |
GetExpression |
Gets a string expression representing this object
(Inherited from IQueryObjectWithValue.) | |
GetFullQueryText |
Gets the full query text including resolved parameters
(Inherited from IDataQuery.) | |
GetListResultT |
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.) | |
GetScalarResultT |
Gets the scalar
(Inherited from IDataQuery.) | |
GetSource |
Gets a source for this query
(Inherited from IDataQuery.) | |
GetTypedQuery |
Returns specifically typed instance of current Query object to allow user to compose Query in fluent syntax.
(Inherited from IQueryParametersTParent.) | |
GroupBy |
Specifies the columns to group by
(Inherited from IDataQuerySettingsTQuery.) | |
HasCompatibleSource |
Returns true if the given query is an external source
(Inherited from IDataQuery.) | |
Having(IWhereCondition) |
Adds the given having conditions to the query.
(Inherited from IDataQuerySettingsTQuery.) | |
Having(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.) | |
Having(String, Boolean) |
Specifies the group by having condition
(Inherited from IDataQuerySettingsTQuery.) | |
Changed |
Marks the object as changed
(Inherited from IQueryObject.) | |
CheckPermissions |
Ensures that the result will be filtered based on user Read permission.
| |
IncludeDataParameters |
Adds the data parameters to the current query parameters
(Inherited from IQueryObject.) | |
InRelationWith |
Ensures that only documents in relationship with a specified document are retrieved.
| |
Intersect |
Gets the intersection of this data query with another query
(Inherited from IDataQueryTQuery.) | |
LatestVersion |
Ensures that latest version of the documents is retrieved.
| |
NestingLevel |
Ensures that only documents within specified nesting level are retrieved.
| |
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 IDataQuerySettingsTQuery.) | |
NewHaving |
Clears the current having condition
(Inherited from IDataQuerySettingsTQuery.) | |
NewWhere |
Clears the current where condition
(Inherited from IWhereConditionTParent.) | |
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 IDataQuerySettingsTQuery.) | |
NoResults |
Sets the where condition to exclude all data from result
(Inherited from IWhereConditionTParent.) | |
NotPaged |
Sets up the query to become not paged query and output all results at once.
(Inherited from IDataQuerySettingsTQuery.) | |
OnCurrentSite |
Filters the data to include only records on the current site.
| |
OnlyGlobal |
Filters the data to include only global objects.
(Inherited from IObjectQueryTQuery, TObject.) | |
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 IObjectQueryTQuery, TObject.) | |
Or |
Changes the where operator to OR for next where conditions. Use in combination of methods Where...
(Inherited from IWhereConditionTParent.) | |
Or(IWhereCondition) |
Adds the given where condition with the OR operator
(Inherited from IWhereConditionTParent.) | |
Or(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.) | |
OrderBy(String) |
Adds the columns to the order by query
(Inherited from IDataQuerySettingsTQuery.) | |
OrderBy(OrderDirection, String) |
Adds the columns to the order by query
(Inherited from IDataQuerySettingsTQuery.) | |
OrderByAscending |
Adds the columns to the order by query to order by the given columns in ascending order
(Inherited from IDataQuerySettingsTQuery.) | |
OrderByDefault |
Sets the default order by for the query
(Inherited from IDataQueryTQuery.) | |
OrderByDescending |
Adds the columns to the order by query to order by the given columns in descending order
(Inherited from IDataQuerySettingsTQuery.) | |
Page |
Specifies the page to select with given page index and page size. Page number is indexed from 0 (first page)
(Inherited from IDataQuerySettingsTQuery.) | |
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 IDataQuerySettingsTQuery.) | |
Path(String) |
Filters the data to include only documents on given path(s).
| |
Path(String, PathTypeEnum) |
Filters the data to include only documents on given path.
| |
Published |
Ensures that only documents published on a live site are retrieved.
| |
PublishedVersion |
Ensures that published version of the documents is retrieved.
| |
ReplaceColumn |
Replaces the selected column with a new name
(Inherited from IDataQuerySettingsTQuery.) | |
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.) | |
SelectT |
Transforms the current result
(Inherited from IDataQuery.) | |
Source |
Defines the source of the data (table, view or a nested query)
(Inherited from IDataQueryTQuery.) | |
Take |
Identity method to make the query expression more readable. Use before the Columns or Page method. Doesn't provide any functionality.
(Inherited from IDataQuerySettingsTQuery.) | |
Then |
Identity method to make the query expression more readable. Use before the OrderBy method. Doesn't provide any functionality.
(Inherited from IDataQuerySettingsTQuery.) | |
TopN |
Selects only first top N number of records
(Inherited from IDataQuerySettingsTQuery.) | |
ToString |
Returns the string representation of the expression, with possibility of expanding parameters
(Inherited from IQueryParameters.) | |
Union |
Gets the union of this data query with another query
(Inherited from IDataQueryTQuery.) | |
UnionAll |
Gets the union of this data query with another query without eliminating the duplicities
(Inherited from IDataQueryTQuery.) | |
Where(IWhereCondition) |
Adds the given where conditions to the query
(Inherited from IWhereConditionTParent.) | |
Where(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.) | |
Where(String, QueryDataParameters) |
Adds the given where condition to the query
(Inherited from IWhereConditionTParent.) | |
Where(String, QueryUnaryOperator) |
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from IWhereConditionTParent.) | |
Where(String, QueryOperator, Object) |
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from IWhereConditionTParent.) | |
WhereAnyColumn |
Matches the given condition on any column with the same type as the given value type.
(Inherited from IDataQueryTQuery.) | |
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 IDataQueryTQuery.) | |
WhereContains |
Adds the condition for a string column to contain some substring
(Inherited from IWhereConditionTParent.) | |
WhereEmpty |
Adds the where condition for a null or empty column value
(Inherited from IWhereConditionTParent.) | |
WhereEquals |
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from IWhereConditionTParent.) | |
WhereEqualsOrNull |
Adds the given where condition to the query. Matches the column to a given value or null value.
(Inherited from IWhereConditionTParent.) | |
WhereExists |
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from IWhereConditionTParent.) | |
WhereFalse |
Adds the where condition for a false column value (boolean column equals false).
(Inherited from IWhereConditionTParent.) | |
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 IWhereConditionTParent.) | |
WhereIn(String, IDataQuery) |
Adds where condition to the nested query, e.g. "columnName IN (...)"
(Inherited from IWhereConditionTParent.) | |
WhereIn(String, ICollectionInt32) |
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from IWhereConditionTParent.) | |
WhereLike |
Adds the given where condition to the query. Matches the column to a given value using LIKE operator.
(Inherited from IWhereConditionTParent.) | |
WhereNot |
Adds the negation of the given where condition
(Inherited from IWhereConditionTParent.) | |
WhereNotContains |
Adds the condition for a string column not to contain some substring
(Inherited from IWhereConditionTParent.) | |
WhereNotEmpty |
Adds the where condition for a non empty column value
(Inherited from IWhereConditionTParent.) | |
WhereNotExists |
Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)"
(Inherited from IWhereConditionTParent.) | |
WhereNotIn(String, IDataQuery) |
Adds where condition to the nested query, e.g. "columnName NOT IN (...)"
(Inherited from IWhereConditionTParent.) | |
WhereNotIn(String, ICollectionInt32) |
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
(Inherited from IWhereConditionTParent.) | |
WhereNotLike |
Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator.
(Inherited from IWhereConditionTParent.) | |
WhereNotNull |
Adds the where condition for a not null column value
(Inherited from IWhereConditionTParent.) | |
WhereNotStartsWith |
Adds the condition for a string column not to start with some prefix
(Inherited from IWhereConditionTParent.) | |
WhereNull |
Adds the where condition for a null column value
(Inherited from IWhereConditionTParent.) | |
WhereStartsWith |
Adds the condition for a string column to start with some prefix
(Inherited from IWhereConditionTParent.) | |
WhereTrue |
Adds the where condition for a true column value (boolean column equals true).
(Inherited from IWhereConditionTParent.) | |
WithCodeName |
Sets the where condition for a specific object code name
(Inherited from IObjectQueryTQuery, TObject.) | |
WithComment |
Adds the comment to the given query
(Inherited from IDataQuerySettingsTQuery.) | |
WithGuid |
Sets the where condition for a specific object GUID
(Inherited from IObjectQueryTQuery, TObject.) | |
WithID |
Sets the where condition for a specific object ID
(Inherited from IObjectQueryTQuery, TObject.) | |
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 IObjectQueryTQuery, TObject.) | |
WithSettings(AbstractQueryObject) |
Applies the given parameters to the query
(Inherited from IDataQueryTQuery.) | |
WithSettings(ActionDataQuerySettings) |
Applies the given parameters to the query
(Inherited from IDataQueryTQuery.) | |
WithSource(DataSet) |
Sets the given DataSet as the source of the data query
(Inherited from IDataQueryTQuery.) | |
WithSource(DataQuerySource) |
Sets the given source as the source of the data query
(Inherited from IDataQueryTQuery.) |