ObjectQuerySettings MembersKentico 8.1 API Reference
The ObjectQuerySettings type exposes the following members.
Constructors

  NameDescription
Public methodObjectQuerySettings
Back to Top
Methods

  NameDescription
Public methodAddColumn(String)
Adds the additional column to the query
(Inherited from DataQuerySettingsBase TQuery .)
Public methodAddColumn(IQueryColumn)
Adds the additional column to the query
(Inherited from DataQuerySettingsBase TQuery .)
Public methodAddColumns(IEnumerable String )
Adds the additional columns to the query
(Inherited from DataQuerySettingsBase TQuery .)
Public methodAddColumns( IQueryColumn )
Adds the additional columns to the query
(Inherited from DataQuerySettingsBase TQuery .)
Public methodAddFilterColumn
Adds the additional filter column to the query
(Inherited from DataQuerySettingsBase TQuery .)
Protected methodAddHavingInternal
Adds the given having condition
(Inherited from DataQuerySettingsBase TQuery .)
Protected methodAddWhereCondition
Adds the given where condition to the final where condition
(Inherited from WhereConditionBase TParent .)
Protected methodAddWhereConditionInternal
Adds the given where condition
(Inherited from WhereConditionBase TParent .)
Public methodAnd 
Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where...
(Inherited from WhereConditionBase TParent .)
Public methodAnd(IWhereCondition)
Adds the given where condition with the AND operator
(Inherited from WhereConditionBase TParent .)
Public methodAnd(Action WhereCondition )
Adds the given where condition with the AND operator. Creates a new where condition object and runs the setup actions on it.
(Inherited from WhereConditionBase TParent .)
Protected methodAnySettingsDefined
Returns true if the object has any settings defined that influence the resulting query
(Inherited from DataQuerySettingsBase TQuery .)
Public methodApplyParametersTo
Applies this query parameters to the target object
(Inherited from DataQuerySettingsBase TQuery .)
Public methodBinaryData
Sets whether the binary data should be included to the result
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 QueryParametersBase TParent .)
Public methodCloneObject
Creates the clone of the object.
(Inherited from QueryParametersBase TParent .)
Public methodColumn(String)
Sets the column to select
(Inherited from DataQuerySettingsBase TQuery .)
Public methodColumn(IQueryColumn)
Sets the column to select
(Inherited from DataQuerySettingsBase TQuery .)
Public methodColumns(IEnumerable String )
Sets the columns to select
(Inherited from DataQuerySettingsBase TQuery .)
Public methodColumns( String )
Sets the columns to select
(Inherited from DataQuerySettingsBase TQuery .)
Public methodCopyPropertiesTo
Creates the clone of the collection.
(Inherited from DataQuerySettingsBase TQuery .)
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 DataQuerySettingsBase TQuery .)
Public methodEnsureParameters
Ensures data parameters for the given query
(Inherited from QueryParametersBase TParent .)
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Public methodExpand
Expands the expression by replacing parameters with their values
(Inherited from QueryParametersBase TParent .)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodFirstResult
Sets the query as a single object query
(Inherited from DataQuerySettingsBase TQuery .)
Public methodGetExpressions
Gets the query expressions
(Inherited from DataQuerySettingsBase TQuery .)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Protected methodGetWhere(String, QueryOperator, Object)
Gets the where condition for the given column
(Inherited from WhereConditionBase TParent .)
Protected methodGetWhere(IQueryObjectWithValue, QueryOperator, Object)
Gets the where condition for the given column
(Inherited from WhereConditionBase TParent .)
Public methodGroupBy
Specifies the columns to group by
(Inherited from DataQuerySettingsBase TQuery .)
Public methodHasCompatibleSource
Returns true if the given query is an external source
(Inherited from WhereConditionBase TParent .)
Public methodHaving( IWhereCondition )
Adds the given having conditions to the query.
(Inherited from DataQuerySettingsBase TQuery .)
Public methodHaving(Action WhereCondition )
Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it.
(Inherited from DataQuerySettingsBase TQuery .)
Public methodHaving(String, Boolean)
Specifies the group by having condition
(Inherited from DataQuerySettingsBase TQuery .)
Public methodChanged
Marks the object as changed
(Inherited from AbstractQueryObject.)
Protected methodCheckReturnsNoResults
Checks if where condition results in no data
(Inherited from WhereConditionBase TParent .)
Public methodImmutable
Makes this object instance is immutable, and next subsequent modification starts with a clone of the object.
(Inherited from QueryParametersBase TParent .)
Public methodIncludeDataParameters
Adds the data parameters to the current query parameters
(Inherited from QueryParametersBase TParent .)
Public methodLock
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from DisposableObject.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
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 DataQuerySettingsBase TQuery .)
Public methodNewHaving
Clears the current having condition
(Inherited from DataQuerySettingsBase TQuery .)
Protected methodNewResult
Returns properly typed this
(Inherited from QueryParametersBase TParent .)
Public methodNewWhere
Clears the current where condition
(Inherited from WhereConditionBase TParent .)
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 DataQuerySettingsBase TQuery .)
Protected methodNoColumns
Sets the query to return no columns at all
(Inherited from DataQuerySettingsBase TQuery .)
Public methodNoResults
Sets the where condition to exclude all data from result
(Inherited from WhereConditionBase TParent .)
Public methodNotPaged
Sets up the query to become not paged query and output all results at once.
(Inherited from DataQuerySettingsBase TQuery .)
Public methodOr 
Changes the where operator to OR for next where conditions. Use in combination of methods Where...
(Inherited from WhereConditionBase TParent .)
Public methodOr(IWhereCondition)
Adds the given where condition with the OR operator
(Inherited from WhereConditionBase TParent .)
Public methodOr(Action WhereCondition )
Adds the given where condition with the OR operator. Creates a new where condition object and runs the setup actions on it.
(Inherited from WhereConditionBase TParent .)
Public methodOrderBy( String )
Adds the columns to the order by query
(Inherited from DataQuerySettingsBase TQuery .)
Public methodOrderBy(OrderDirection,  String )
Adds the columns to the order by query
(Inherited from DataQuerySettingsBase TQuery .)
Public methodOrderByAscending
Adds the columns to the order by query to order by the given columns in ascending order
(Inherited from DataQuerySettingsBase TQuery .)
Public methodOrderByDescending
Adds the columns to the order by query to order by the given columns in descending order
(Inherited from DataQuerySettingsBase TQuery .)
Public methodPage
Specifies the page to select with given page index and page size. Page number is indexed from 0 (first page)
(Inherited from DataQuerySettingsBase TQuery .)
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 DataQuerySettingsBase TQuery .)
Public methodReplaceColumn
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBase TQuery .)
Protected methodReplaceOrderByColumn
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBase TQuery .)
Protected methodReplaceSelectedColumn
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBase TQuery .)
Protected methodResetWhereOperator
Resets the where operator to the default value
(Inherited from WhereConditionBase TParent .)
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 WhereConditionBase TParent .)
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 QueryParametersBase TParent .)
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 DataQuerySettingsBase TQuery .)
Public methodThen
Identity method to make the query expression more readable. Use before the OrderBy method. Doesn't provide any functionality.
(Inherited from DataQuerySettingsBase TQuery .)
Public methodTopN
Selects only first top N number of records
(Inherited from DataQuerySettingsBase TQuery .)
Public methodToString 
Returns the string representation of the expression
(Inherited from QueryParametersBase TParent .)
Public methodToString(Boolean)
Returns the string representation of the expression, with possibility of expanding parameters
(Inherited from DataQuerySettingsBase TQuery .)
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 WhereConditionBase TParent .)
Public methodWhere(Action WhereCondition )
Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it.
(Inherited from WhereConditionBase TParent .)
Public methodWhere(String, QueryDataParameters)
Adds the given where condition to the query
(Inherited from WhereConditionBase TParent .)
Public methodWhere(String, QueryUnaryOperator)
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from WhereConditionBase TParent .)
Public methodWhere(IQueryObjectWithValue, QueryUnaryOperator)
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from WhereConditionBase TParent .)
Public methodWhere(String, QueryOperator, Object)
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBase TParent .)
Public methodWhere(IQueryObjectWithValue, QueryOperator, Object)
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBase TParent .)
Public methodWhereContains(String, String)
Adds the condition for a string column to contain some substring
(Inherited from WhereConditionBase TParent .)
Public methodWhereContains(IQueryObjectWithValue, String)
Adds the condition for a string column to contain some substring
(Inherited from WhereConditionBase TParent .)
Public methodWhereEmpty
Adds the where condition for a null or empty column value
(Inherited from WhereConditionBase TParent .)
Public methodWhereEndsWith(String, String)
Adds the condition for a string column to end with some prefix
(Inherited from WhereConditionBase TParent .)
Public methodWhereEndsWith(IQueryObjectWithValue, String)
Adds the condition for a string expression to end with some prefix
(Inherited from WhereConditionBase TParent .)
Public methodWhereEquals(String, Object)
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBase TParent .)
Public methodWhereEquals(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side to the given right side.
(Inherited from WhereConditionBase TParent .)
Public methodWhereEqualsOrNull
Adds the given where condition to the query. Matches the column to a given value or null value.
(Inherited from WhereConditionBase TParent .)
Public methodWhereExists(IDataQuery)
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from WhereConditionBase TParent .)
Protected methodWhereExists(IDataQuery, Boolean)
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from WhereConditionBase TParent .)
Public methodWhereFalse(String)
Adds the where condition for a false column value (boolean column equals false).
(Inherited from WhereConditionBase TParent .)
Public methodWhereFalse(IQueryObjectWithValue)
Adds the where condition for a false expression value (boolean expression equals false).
(Inherited from WhereConditionBase TParent .)
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 WhereConditionBase TParent .)
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 WhereConditionBase TParent .)
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 WhereConditionBase TParent .)
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 WhereConditionBase TParent .)
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 WhereConditionBase TParent .)
Public methodWhereIn(String, IDataQuery)
Adds where condition to the nested query, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase TParent .)
Public methodWhereIn(String, IList Int32 )
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase TParent .)
Protected methodWhereIn(String, IDataQuery, Boolean)
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase TParent .)
Protected methodWhereIn(String, IList Int32 , Boolean)
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase TParent .)
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 WhereConditionBase TParent .)
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 WhereConditionBase TParent .)
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 WhereConditionBase TParent .)
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 WhereConditionBase TParent .)
Public methodWhereLike(String, String)
Adds the given where condition to the query. Matches the column to a given value using LIKE operator.
(Inherited from WhereConditionBase TParent .)
Public methodWhereLike(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side and right side using LIKE operator.
(Inherited from WhereConditionBase TParent .)
Public methodWhereNot
Adds the negation of the given where condition
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotContains(String, String)
Adds the condition for a string column not to contain some substring
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotContains(IQueryObjectWithValue, String)
Adds the condition for a string column not to contain some substring
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotEmpty
Adds the where condition for a non empty column value
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotEndsWith(String, String)
Adds the condition for a string column not to end with some prefix
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotEndsWith(IQueryObjectWithValue, String)
Adds the condition for a string column not to end with some prefix
(Inherited from WhereConditionBase TParent .)
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 WhereConditionBase TParent .)
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 WhereConditionBase TParent .)
Public methodWhereNotExists
Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)"
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotIn(String, IDataQuery)
Adds where condition to the nested query, e.g. "columnName NOT IN (...)"
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotIn(String, IList Int32 )
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
(Inherited from WhereConditionBase TParent .)
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 WhereConditionBase TParent .)
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 WhereConditionBase TParent .)
Public methodWhereNotNull(String)
Adds the where condition for a not null column value
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotNull(IQueryObjectWithValue)
Adds the where condition for a not null expression value
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotStartsWith(String, String)
Adds the condition for a string column not to start with some prefix
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotStartsWith(IQueryObjectWithValue, String)
Adds the condition for a string column not to start with some prefix
(Inherited from WhereConditionBase TParent .)
Public methodWhereNull(String)
Adds the where condition for a null column value
(Inherited from WhereConditionBase TParent .)
Public methodWhereNull(IQueryObjectWithValue)
Adds the where condition for a null expression value
(Inherited from WhereConditionBase TParent .)
Public methodWhereStartsWith(String, String)
Adds the condition for a string column to start with some prefix
(Inherited from WhereConditionBase TParent .)
Public methodWhereStartsWith(IQueryObjectWithValue, String)
Adds the condition for a string column to start with some prefix
(Inherited from WhereConditionBase TParent .)
Public methodWhereTrue(String)
Adds the where condition for a true column value (boolean column equals true).
(Inherited from WhereConditionBase TParent .)
Public methodWhereTrue(IQueryObjectWithValue)
Adds the where condition for a true expression value (boolean expression equals true).
(Inherited from WhereConditionBase TParent .)
Public methodWithComment
Adds the comment to the given query
(Inherited from DataQuerySettingsBase TQuery .)
Back to 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 MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
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.)
Back to Top
Fields

  NameDescription
Protected fieldmMaxRecords
Maximum number of records to select
(Inherited from DataQuerySettingsBase TQuery .)
Protected fieldmOffset
Offset
(Inherited from DataQuerySettingsBase TQuery .)
Protected fieldmParameters
Query data parameters
(Inherited from QueryParametersBase TParent .)
Back to Top
Properties

  NameDescription
Public propertyDefaultSourceExpression
Default source of the query in case source is not defined
(Inherited from DataQuerySettingsBase TQuery .)
Public propertyDisposeUsedObjects
Disposes the objects that were used as parameters for this query
(Inherited from WhereConditionBase TParent .)
Public propertyFilterColumns
List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"
(Inherited from DataQuerySettingsBase TQuery .)
Protected propertyForceOrderBy
If true, the order by should be forced in the process of execution
(Inherited from DataQuerySettingsBase TQuery .)
Public propertyGroupByColumns
List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
(Inherited from DataQuerySettingsBase TQuery .)
Public propertyHasGroupBy
Returns true if the given query has group by set
(Inherited from DataQuerySettingsBase TQuery .)
Public propertyHavingCondition
Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
(Inherited from DataQuerySettingsBase TQuery .)
Public propertyHavingIsComplex
Returns true if the given having condition is a complex condition
(Inherited from DataQuerySettingsBase TQuery .)
Public propertyHavingIsEmpty
Returns true if the having condition is empty
(Inherited from DataQuerySettingsBase TQuery .)
Public propertyIncludeBinaryData
If true, the query includes the object binary data. Default is false
Protected propertyIsImmutable
If true, this object instance is immutable, and next subsequent modification starts with a clone of the object.
(Inherited from QueryParametersBase TParent .)
Public propertyIsNested
Indicates that this query is part of multi query
(Inherited from AbstractQueryObject.)
Public propertyIsPagedQuery
Returns true if the query has the paging enabled
(Inherited from DataQuerySettingsBase TQuery .)
Public propertyMaxRecords
Maximum number of results to return (use for paging together with Offset)
(Inherited from DataQuerySettingsBase TQuery .)
Public propertyName
Object name, empty by default
(Inherited from AbstractQueryObject.)
Public propertyOffset
Index of the first record to return (use for paging together with MaxRecords)
(Inherited from DataQuerySettingsBase TQuery .)
Public propertyOrderByColumns
List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"
(Inherited from DataQuerySettingsBase TQuery .)
Public propertyParameters
Query data parameters
(Inherited from QueryParametersBase TParent .)
Public propertyReturnsNoResults
Returns true if query doesn't return any results
(Inherited from WhereConditionBase TParent .)
Public propertySelectColumnsObsolete.
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from DataQuerySettingsBase TQuery .)
Public propertySelectColumnsList
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from DataQuerySettingsBase TQuery .)
Public propertySelectDistinct
If set to true, returns only distinct (different) values.
(Inherited from DataQuerySettingsBase TQuery .)
Public propertySourceExpression
Source of the query
(Inherited from DataQuerySettingsBase TQuery .)
Public propertyTopNRecords
If set, selects only first top N number of records
(Inherited from DataQuerySettingsBase TQuery .)
Protected propertyWhereBuilder
Where condition builder
(Inherited from WhereConditionBase TParent .)
Public propertyWhereCondition
Where condition on the data, e.g. "DocumentName = 'ABC'"
(Inherited from WhereConditionBase TParent .)
Public propertyWhereIsComplex
Returns true if the given where condition is a complex where condition
(Inherited from WhereConditionBase TParent .)
Public propertyWhereIsEmpty
Returns true if the where condition is empty
(Inherited from WhereConditionBase TParent .)
Protected propertyWhereOperator
Operator used for adding where condition. Default is AND
(Inherited from WhereConditionBase TParent .)
Back to Top
See Also