ObjectQuerySettings Class |
Namespace: CMS.DataEngine
public class ObjectQuerySettings : DataQuerySettingsBase<ObjectQuerySettings>
The ObjectQuerySettings type exposes the following members.
Name | Description | |
---|---|---|
ObjectQuerySettings |
Name | Description | |
---|---|---|
mMaxRecords |
Maximum number of records to select
(Inherited from DataQuerySettingsBaseTQuery.) | |
mOffset |
Offset
(Inherited from DataQuerySettingsBaseTQuery.) | |
mOrderByColumns |
Order by columns
(Inherited from DataQuerySettingsBaseTQuery.) | |
mParameters |
Query data parameters
(Inherited from QueryParametersBaseTParent.) | |
mSelectColumnsList |
Columns to select
(Inherited from DataQuerySettingsBaseTQuery.) |
Name | Description | |
---|---|---|
DataSourceName |
Data source identifier that represents the location from which the data are obtained.
(Inherited from WhereConditionBaseTParent.) | |
DefaultQuerySource |
Default source of the query in case source is not defined
(Inherited from DataQuerySettingsBaseTQuery.) | |
DisposeUsedObjects |
Disposes the objects that were used as parameters for this query
(Inherited from WhereConditionBaseTParent.) | |
FilterColumns |
List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"
(Inherited from DataQuerySettingsBaseTQuery.) | |
ForceOrderBy |
If true, the order by should be forced in the process of execution
(Inherited from DataQuerySettingsBaseTQuery.) | |
GroupByColumns |
List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
(Inherited from DataQuerySettingsBaseTQuery.) | |
HasGroupBy |
Returns true if the given query has group by set
(Inherited from DataQuerySettingsBaseTQuery.) | |
HavingCondition |
Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
(Inherited from DataQuerySettingsBaseTQuery.) | |
HavingIsComplex |
Returns true if the given having condition is a complex condition
(Inherited from DataQuerySettingsBaseTQuery.) | |
HavingIsEmpty |
Returns true if the having condition is empty
(Inherited from DataQuerySettingsBaseTQuery.) | |
IncludeBinaryData |
If true, the query includes the object binary data. Default is false
| |
IsImmutable |
If true, this object instance is immutable, and next subsequent modification starts with a clone of the object.
(Inherited from QueryParametersBaseTParent.) | |
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 DataQuerySettingsBaseTQuery.) | |
IsPagedQuery |
Returns true if the query has the paging enabled
(Inherited from DataQuerySettingsBaseTQuery.) | |
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 DataQuerySettingsBaseTQuery.) | |
MaxRecords |
Maximum number of results to return (use for paging together with Offset)
(Inherited from DataQuerySettingsBaseTQuery.) | |
Name |
Object name, empty by default
(Inherited from AbstractQueryObject.) | |
Offset |
Index of the first record to return (use for paging together with MaxRecords)
(Inherited from DataQuerySettingsBaseTQuery.) | |
OrderByColumns |
List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"
(Inherited from DataQuerySettingsBaseTQuery.) | |
Parameters |
Query data parameters
(Inherited from QueryParametersBaseTParent.) | |
QuerySource |
Query source object
(Inherited from DataQuerySettingsBaseTQuery.) | |
ReturnsNoResults |
Returns true if query doesn't return any results
(Inherited from WhereConditionBaseTParent.) | |
SelectColumnsList |
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from DataQuerySettingsBaseTQuery.) | |
SelectDistinct |
If set to true, returns only distinct (different) values.
(Inherited from DataQuerySettingsBaseTQuery.) | |
TopNRecords |
If set, selects only first top N number of records
(Inherited from DataQuerySettingsBaseTQuery.) | |
TotalExpression |
Total items expression. When defined, used instead default total items for a paged query.
(Inherited from DataQuerySettingsBaseTQuery.) | |
WhereBuilder |
Where condition builder
(Inherited from WhereConditionBaseTParent.) | |
WhereCondition |
Where condition on the data, e.g. "DocumentName = 'ABC'"
(Inherited from WhereConditionBaseTParent.) | |
WhereIsComplex |
Returns true if the given where condition contains compound conditions, e. g. "A > 1 AND B = 5"
(Inherited from WhereConditionBaseTParent.) | |
WhereIsEmpty |
Returns true if the where condition is empty
(Inherited from WhereConditionBaseTParent.) | |
WhereOperator |
Operator used for adding where condition. Default is AND
(Inherited from WhereConditionBaseTParent.) |
Name | Description | |
---|---|---|
AddColumn(String) |
Adds the additional column to the query
(Inherited from DataQuerySettingsBaseTQuery.) | |
AddColumn(IQueryColumn) |
Adds the additional column to the query
(Inherited from DataQuerySettingsBaseTQuery.) | |
AddColumns(IEnumerableString) |
Adds the additional columns to the query
(Inherited from DataQuerySettingsBaseTQuery.) | |
AddColumns(String) |
Adds the additional columns to the query
(Inherited from DataQuerySettingsBaseTQuery.) | |
AddColumns(IQueryColumn) |
Adds the additional columns to the query
(Inherited from DataQuerySettingsBaseTQuery.) | |
AddFilterColumn |
Adds the additional filter column to the query
(Inherited from DataQuerySettingsBaseTQuery.) | |
AddHavingInternal |
Adds the given having condition
(Inherited from DataQuerySettingsBaseTQuery.) | |
AddWhereCondition |
Adds the given where condition to the final where condition
(Inherited from WhereConditionBaseTParent.) | |
AddWhereConditionInternal |
Adds the given where condition
(Inherited from WhereConditionBaseTParent.) | |
And |
Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where...
(Inherited from WhereConditionBaseTParent.) | |
And(IWhereCondition) |
Adds the given where condition with the AND operator
(Inherited from WhereConditionBaseTParent.) | |
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 WhereConditionBaseTParent.) | |
AnySettingsDefined |
Returns true if the object has any settings defined that influence the resulting query
(Inherited from DataQuerySettingsBaseTQuery.) | |
ApplyParametersTo |
Applies this query parameters to the target object
(Inherited from DataQuerySettingsBaseTQuery.) | |
BinaryData |
Sets whether the binary data should be included to the result
| |
CallOnDispose |
Adds the given action to the list of actions called when the handler object is disposed
(Inherited from DisposableObject.) | |
Clone |
Creates the clone of the object.
(Inherited from QueryParametersBaseTParent.) | |
CloneObject |
Creates the clone of the object.
(Inherited from QueryParametersBaseTParent.) | |
Column(String) |
Sets the column to select
(Inherited from DataQuerySettingsBaseTQuery.) | |
Column(IQueryColumn) |
Sets the column to select
(Inherited from DataQuerySettingsBaseTQuery.) | |
Columns(IEnumerableString) |
Sets the columns to select
(Inherited from DataQuerySettingsBaseTQuery.) | |
Columns(String) |
Sets the columns to select
(Inherited from DataQuerySettingsBaseTQuery.) | |
Columns(IQueryColumn) |
Sets the columns to select
(Inherited from DataQuerySettingsBaseTQuery.) | |
CopyPropertiesTo |
Creates the clone of the collection.
(Inherited from DataQuerySettingsBaseTQuery.) | |
Dispose |
Make sure the objects get disposed
(Inherited from DisposableObject.) | |
Distinct |
Sets the query to use distinct selection over the given columns
(Inherited from DataQuerySettingsBaseTQuery.) | |
EnsureParameters |
Ensures data parameters for the given query
(Inherited from QueryParametersBaseTParent.) | |
Equals(Object) | (Inherited from WhereConditionBaseTParent.) | |
Equals(TParent) |
Indicates whether the current object is equal to another object of the same type.
(Inherited from WhereConditionBaseTParent.) | |
Expand |
Expands the expression by replacing parameters with their values
(Inherited from QueryParametersBaseTParent.) | |
GetDataSourceName |
Gets data source identifier that represents the location from which the data are obtained.
(Inherited from WhereConditionBaseTParent.) | |
GetDefaultSource |
Gets the default source for this query
(Inherited from DataQuerySettingsBaseTQuery.) | |
GetExpressions |
Gets the query expressions
(Inherited from DataQuerySettingsBaseTQuery.) | |
GetHashCode |
Serves as a hash function for a particular type.
(Inherited from WhereConditionBaseTParent.) | |
GetTypedQuery |
Returns specifically typed instance of current Query object to allow user to compose Query in fluent syntax. If current Query is immutable then its clone is returned.
(Inherited from QueryParametersBaseTParent.) | |
GetWhere(String, QueryOperator, Object) |
Gets the where condition for the given column
(Inherited from WhereConditionBaseTParent.) | |
GetWhere(IQueryObjectWithValue, QueryOperator, Object) |
Gets the where condition for the given column
(Inherited from WhereConditionBaseTParent.) | |
GroupBy |
Specifies the columns to group by
(Inherited from DataQuerySettingsBaseTQuery.) | |
HasCompatibleSource |
Returns true if the given query is an external source
(Inherited from WhereConditionBaseTParent.) | |
Having(IWhereCondition) |
Adds the given having conditions to the query.
(Inherited from DataQuerySettingsBaseTQuery.) | |
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 DataQuerySettingsBaseTQuery.) | |
Having(String, Boolean) |
Specifies the having condition
(Inherited from DataQuerySettingsBaseTQuery.) | |
Changed |
Marks the object as changed
(Inherited from AbstractQueryObject.) | |
CheckReturnsNoResults |
Checks if where condition results in no data
(Inherited from WhereConditionBaseTParent.) | |
Immutable |
Makes this object instance is immutable, and next subsequent modification starts with a clone of the object.
(Inherited from QueryParametersBaseTParent.) | |
IncludeDataParameters |
Adds the data parameters to the current query parameters
(Inherited from QueryParametersBaseTParent.) | |
Lock |
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from DisposableObject.) | |
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 DataQuerySettingsBaseTQuery.) | |
NewHaving |
Clears the current having condition
(Inherited from DataQuerySettingsBaseTQuery.) | |
NewWhere |
Clears the current where condition
(Inherited from WhereConditionBaseTParent.) | |
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 DataQuerySettingsBaseTQuery.) | |
NoColumns |
Sets the query to return no columns at all
(Inherited from DataQuerySettingsBaseTQuery.) | |
NoResults |
Sets the where condition to exclude all data from result
(Inherited from WhereConditionBaseTParent.) | |
NotPaged |
Sets up the query to become not paged query and output all results at once.
(Inherited from DataQuerySettingsBaseTQuery.) | |
Or |
Changes the where operator to OR for next where conditions. Use in combination of methods Where...
(Inherited from WhereConditionBaseTParent.) | |
Or(IWhereCondition) |
Adds the given where condition with the OR operator
(Inherited from WhereConditionBaseTParent.) | |
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 WhereConditionBaseTParent.) | |
OrderBy(String) |
Adds the columns to the order by query
(Inherited from DataQuerySettingsBaseTQuery.) | |
OrderBy(OrderDirection, String) |
Adds the columns to the order by query
(Inherited from DataQuerySettingsBaseTQuery.) | |
OrderByAscending |
Adds the columns to the order by query to order by the given columns in ascending order
(Inherited from DataQuerySettingsBaseTQuery.) | |
OrderByDescending |
Adds the columns to the order by query to order by the given columns in descending order
(Inherited from DataQuerySettingsBaseTQuery.) | |
Page |
Specifies the page to select with given page index and page size. Page number is indexed from 0 (first page)
(Inherited from DataQuerySettingsBaseTQuery.) | |
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 DataQuerySettingsBaseTQuery.) | |
ReplaceColumn |
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBaseTQuery.) | |
ReplaceOrderByColumn |
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBaseTQuery.) | |
ReplaceSelectedColumn |
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBaseTQuery.) | |
Reset |
Flushes the results but leaves the generated query text unchanged.
After the reset, query can be executed again to obtain new data.
(Inherited from AbstractQueryObject.) | |
ResetWhereOperator |
Resets the where operator to the default value
(Inherited from WhereConditionBaseTParent.) | |
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 WhereConditionBaseTParent.) | |
Snapshot |
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.) | |
Take |
Identity method to make the query expression more readable. Use before the Columns or Page method. Doesn't provide any functionality.
(Inherited from DataQuerySettingsBaseTQuery.) | |
Then |
Identity method to make the query expression more readable. Use before the OrderBy method. Doesn't provide any functionality.
(Inherited from DataQuerySettingsBaseTQuery.) | |
TopN |
Selects only first top N number of records
(Inherited from DataQuerySettingsBaseTQuery.) | |
ToString |
Returns the string representation of the expression
(Inherited from QueryParametersBaseTParent.) | |
ToString(Boolean) |
Returns the string representation of the expression, with possibility of expanding parameters
(Inherited from DataQuerySettingsBaseTQuery.) | |
Using |
Adds the given object to the list of the allocated objects to dispose
(Inherited from DisposableObject.) | |
Where(IWhereCondition) |
Adds the given where conditions to the query
(Inherited from WhereConditionBaseTParent.) | |
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 WhereConditionBaseTParent.) | |
Where(String, QueryDataParameters) |
Adds the given where condition to the query
(Inherited from WhereConditionBaseTParent.) | |
Where(String, QueryUnaryOperator) |
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from WhereConditionBaseTParent.) | |
Where(IQueryObjectWithValue, QueryUnaryOperator) |
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from WhereConditionBaseTParent.) | |
Where(String, QueryOperator, Object) |
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBaseTParent.) | |
Where(IQueryObjectWithValue, QueryOperator, Object) |
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBaseTParent.) | |
WhereContains(String, String) |
Adds the condition for a string column to contain some substring
(Inherited from WhereConditionBaseTParent.) | |
WhereContains(IQueryObjectWithValue, String) |
Adds the condition for a string column to contain some substring
(Inherited from WhereConditionBaseTParent.) | |
WhereEmpty |
Adds the where condition for a null or empty column value
(Inherited from WhereConditionBaseTParent.) | |
WhereEndsWith(String, String) |
Adds the condition for a string column to end with some prefix
(Inherited from WhereConditionBaseTParent.) | |
WhereEndsWith(IQueryObjectWithValue, String) |
Adds the condition for a string expression to end with some prefix
(Inherited from WhereConditionBaseTParent.) | |
WhereEquals(String, Object) |
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBaseTParent.) | |
WhereEquals(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side to the given right side.
(Inherited from WhereConditionBaseTParent.) | |
WhereEqualsOrNull |
Adds the given where condition to the query. Matches the column to a given value or null value.
(Inherited from WhereConditionBaseTParent.) | |
WhereExists(IDataQuery) |
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from WhereConditionBaseTParent.) | |
WhereExists(IDataQuery, Boolean) |
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from WhereConditionBaseTParent.) | |
WhereFalse(String) |
Adds the where condition for a false column value (boolean column equals false).
(Inherited from WhereConditionBaseTParent.) | |
WhereFalse(IQueryObjectWithValue) |
Adds the where condition for a false expression value (boolean expression equals false).
(Inherited from WhereConditionBaseTParent.) | |
WhereGreaterOrEquals(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.) | |
WhereGreaterOrEquals(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.) | |
WhereGreaterThan(String, Object) |
Adds the given where condition to the query. Matches the left side which is greater than the right side.
(Inherited from WhereConditionBaseTParent.) | |
WhereGreaterThan(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side which is greater than the right side.
(Inherited from WhereConditionBaseTParent.) | |
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 WhereConditionBaseTParent.) | |
WhereIn(String, IDataQuery) |
Adds where condition to the nested query, e.g. "columnName IN (...)"
(Inherited from WhereConditionBaseTParent.) | |
WhereIn(String, ICollectionInt32) |
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBaseTParent.) | |
WhereIn(String, IDataQuery, Boolean) |
Adds where condition to the list of values, e.g. "columnName IN (...)".
Supported generic type is int, long, string or guid ONLY!
(Inherited from WhereConditionBaseTParent.) | |
WhereIn(String, ICollectionInt32, Boolean) |
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBaseTParent.) | |
WhereLessOrEquals(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.) | |
WhereLessOrEquals(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.) | |
WhereLessThan(String, Object) |
Adds the given where condition to the query. Matches the left side which is less than the right side.
(Inherited from WhereConditionBaseTParent.) | |
WhereLessThan(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side which is less than the right side.
(Inherited from WhereConditionBaseTParent.) | |
WhereLike(String, String) |
Adds the given where condition to the query. Matches the column to a given value using LIKE operator.
(Inherited from WhereConditionBaseTParent.) | |
WhereLike(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side and right side using LIKE operator.
(Inherited from WhereConditionBaseTParent.) | |
WhereNot |
Adds the negation of the given where condition
(Inherited from WhereConditionBaseTParent.) | |
WhereNotContains(String, String) |
Adds the condition for a string column not to contain some substring
(Inherited from WhereConditionBaseTParent.) | |
WhereNotContains(IQueryObjectWithValue, String) |
Adds the condition for a string column not to contain some substring
(Inherited from WhereConditionBaseTParent.) | |
WhereNotEmpty |
Adds the where condition for a non empty column value
(Inherited from WhereConditionBaseTParent.) | |
WhereNotEndsWith(String, String) |
Adds the condition for a string column not to end with some prefix
(Inherited from WhereConditionBaseTParent.) | |
WhereNotEndsWith(IQueryObjectWithValue, String) |
Adds the condition for a string column not to end with some prefix
(Inherited from WhereConditionBaseTParent.) | |
WhereNotEquals(String, Object) |
Adds the given where condition to the query. Matches the column which is not equal to a given value.
(Inherited from WhereConditionBaseTParent.) | |
WhereNotEquals(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.) | |
WhereNotExists |
Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)"
(Inherited from WhereConditionBaseTParent.) | |
WhereNotIn(String, IDataQuery) |
Adds where condition to the nested query, e.g. "columnName NOT IN (...)"
(Inherited from WhereConditionBaseTParent.) | |
WhereNotIn(String, ICollectionInt32) |
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
(Inherited from WhereConditionBaseTParent.) | |
WhereNotLike(String, String) |
Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator.
(Inherited from WhereConditionBaseTParent.) | |
WhereNotLike(IQueryObjectWithValue, Object) |
Adds the given where condition to the query. Matches the left side and right side using NOT LIKE operator.
(Inherited from WhereConditionBaseTParent.) | |
WhereNotNull(String) |
Adds the where condition for a not null column value
(Inherited from WhereConditionBaseTParent.) | |
WhereNotNull(IQueryObjectWithValue) |
Adds the where condition for a not null expression value
(Inherited from WhereConditionBaseTParent.) | |
WhereNotStartsWith(String, String) |
Adds the condition for a string column not to start with some prefix
(Inherited from WhereConditionBaseTParent.) | |
WhereNotStartsWith(IQueryObjectWithValue, String) |
Adds the condition for a string column not to start with some prefix
(Inherited from WhereConditionBaseTParent.) | |
WhereNull(String) |
Adds the where condition for a null column value
(Inherited from WhereConditionBaseTParent.) | |
WhereNull(IQueryObjectWithValue) |
Adds the where condition for a null expression value
(Inherited from WhereConditionBaseTParent.) | |
WhereStartsWith(String, String) |
Adds the condition for a string column to start with some prefix
(Inherited from WhereConditionBaseTParent.) | |
WhereStartsWith(IQueryObjectWithValue, String) |
Adds the condition for a string column to start with some prefix
(Inherited from WhereConditionBaseTParent.) | |
WhereTrue(String) |
Adds the where condition for a true column value (boolean column equals true).
(Inherited from WhereConditionBaseTParent.) | |
WhereTrue(IQueryObjectWithValue) |
Adds the where condition for a true expression value (boolean expression equals true).
(Inherited from WhereConditionBaseTParent.) | |
WithComment |
Adds the comment to the given query
(Inherited from DataQuerySettingsBaseTQuery.) |
Name | Description | |
---|---|---|
WhereNotExpiredObjectQuerySettings |
Filters out objects which have their 'Expiration' column's day (e.g. Expiration) before
currentDateTime.
(Defined by ScoreContactRuleInfoObjectQueryExtensions.) |