Click or drag to resize
WhereConditionBaseTParent Class
Where condition builder - Generic base class
Inheritance Hierarchy
SystemObject
  CMS.BaseDisposableObject
    CMS.DataEngineAbstractQueryObject
      CMS.DataEngineQueryParametersBaseTParent
        CMS.DataEngineWhereConditionBaseTParent
          CMS.DataEngineDataQuerySettingsBaseTQuery
          CMS.DataEngineWhereCondition

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 12.0.0
Syntax
C#
public abstract class WhereConditionBase<TParent> : QueryParametersBase<TParent>, 
	IWhereCondition<TParent>, IWhereCondition, IQueryParameters, IQueryObject, IDisposable, 
	IQueryParameters<TParent>, IEquatable<TParent>
where TParent : new(), WhereConditionBase<TParent>

Type Parameters

TParent

The WhereConditionBaseTParent type exposes the following members.

Constructors
Fields
Properties
  NameDescription
Public propertyDataSourceName
Data source identifier that represents the location from which the data are obtained.
Protected propertyIsImmutable
If true, this object instance is immutable, and next subsequent modification starts with a clone of the object.
(Inherited from QueryParametersBaseTParent.)
Public propertyName
Object name, empty by default
(Inherited from AbstractQueryObject.)
Public propertyParameters
Query data parameters
(Inherited from QueryParametersBaseTParent.)
Public propertyReturnsNoResults
Returns true if query doesn't return any results
Protected propertyWhereBuilder
Where condition builder
Public propertyWhereCondition
Where condition on the data, e.g. "DocumentName = 'ABC'"
Public propertyWhereIsComplex
Returns true if the given where condition contains compound conditions, e. g. "A > 1 AND B = 5"
Public propertyWhereIsEmpty
Returns true if the where condition is empty
Protected propertyWhereOperator
Operator used for adding where condition. Default is AND
Top
Methods
  NameDescription
Protected methodAddWhereCondition
Adds the given where condition to the final where condition
Protected methodAddWhereConditionInternal
Adds the given where condition
Public methodAnd
Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where...
Public methodAnd(IWhereCondition)
Adds the given where condition with the AND operator
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.
Protected methodAnySettingsDefined
Returns true if the object has any settings defined that influence the resulting query
Public methodApplyParametersTo
Applies this where condition to the target object
(Overrides QueryParametersBaseTParentApplyParametersTo(IQueryObject).)
Public methodCallOnDispose
Adds the given action to the list of actions called when the handler object is disposed
(Inherited from DisposableObject.)
Public methodChanged
Marks the object as changed
(Inherited from AbstractQueryObject.)
Protected methodCheckReturnsNoResults
Checks if where condition results in no data
Public methodClone
Creates the clone of the object.
(Inherited from QueryParametersBaseTParent.)
Public methodCloneObject
Creates the clone of the object.
(Inherited from QueryParametersBaseTParent.)
Public methodCopyPropertiesTo
Creates the clone of the collection.
(Overrides QueryParametersBaseTParentCopyPropertiesTo(IQueryObject).)
Public methodDispose
Make sure the objects get disposed
(Inherited from DisposableObject.)
Public methodEnsureParameters
Ensures data parameters for the given query
(Inherited from QueryParametersBaseTParent.)
Public methodEquals(Object)
Determines whether the specified Object is equal to the current Object.
(Overrides ObjectEquals(Object).)
Public methodEquals(TParent)
Indicates whether the current object is equal to another object of the same type.
Public methodExpand
Expands the expression by replacing parameters with their values
(Inherited from QueryParametersBaseTParent.)
Protected methodStatic memberGetContainsPattern
Gets the contains pattern for the like expression
Protected methodGetDataSourceName
Gets data source identifier that represents the location from which the data are obtained.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Overrides ObjectGetHashCode.)
Public methodGetTypedQuery
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.)
Protected methodGetWhere(String, QueryOperator, Object)
Gets the where condition for the given column
Protected methodGetWhere(IQueryObjectWithValue, QueryOperator, Object)
Gets the where condition for the given column
Public methodHasCompatibleSource
Returns true if the given query is an external source
Public methodImmutable
Makes this object instance is immutable, and next subsequent modification starts with a clone of the object.
(Inherited from QueryParametersBaseTParent.)
Public methodIncludeDataParameters
Adds the data parameters to the current query parameters
(Inherited from QueryParametersBaseTParent.)
Public methodLock
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from DisposableObject.)
Public methodNewWhere
Clears the current where condition
Public methodNoResults
Sets the where condition to exclude all data from result
Public methodOr
Changes the where operator to OR for next where conditions. Use in combination of methods Where...
Public methodOr(IWhereCondition)
Adds the given where condition with the OR operator
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.
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 AbstractQueryObject.)
Protected methodResetWhereOperator
Resets the where operator to the default value
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.
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 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
(Overrides QueryParametersBaseTParentToString(Boolean).)
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
Public methodWhere(ActionWhereCondition)
Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it.
Public methodWhere(String, QueryDataParameters)
Adds the given where condition to the query
Public methodWhere(String, QueryUnaryOperator)
Adds the given where condition to the query. Matches the column value with an unary operator.
Public methodWhere(IQueryObjectWithValue, QueryUnaryOperator)
Adds the given where condition to the query. Matches the column value with an unary operator.
Public methodWhere(String, QueryOperator, Object)
Adds the given where condition to the query. Matches the column to a given value.
Public methodWhere(IQueryObjectWithValue, QueryOperator, Object)
Adds the given where condition to the query. Matches the column to a given value.
Public methodWhereContains(String, String)
Adds the condition for a string column to contain some substring
Public methodWhereContains(IQueryObjectWithValue, String)
Adds the condition for a string column to contain some substring
Public methodWhereEmpty
Adds the where condition for a null or empty column value
Public methodWhereEndsWith(String, String)
Adds the condition for a string column to end with some prefix
Public methodWhereEndsWith(IQueryObjectWithValue, String)
Adds the condition for a string expression to end with some prefix
Public methodWhereEquals(String, Object)
Adds the given where condition to the query. Matches the column to a given value.
Public methodWhereEquals(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side to the given right side.
Public methodWhereEqualsOrNull
Adds the given where condition to the query. Matches the column to a given value or null value.
Public methodWhereExists(IDataQuery)
Adds where condition with EXISTS and the nested query "EXISTS (...)"
Protected methodWhereExists(IDataQuery, Boolean)
Adds where condition with EXISTS and the nested query "EXISTS (...)"
Public methodWhereFalse(String)
Adds the where condition for a false column value (boolean column equals false).
Public methodWhereFalse(IQueryObjectWithValue)
Adds the where condition for a false expression value (boolean expression equals false).
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.
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.
Public methodWhereGreaterThan(String, Object)
Adds the given where condition to the query. Matches the left side which is greater than the right side.
Public methodWhereGreaterThan(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side which is greater than the right side.
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.
Public methodWhereIn(String, IDataQuery)
Adds where condition to the nested query, e.g. "columnName IN (...)"
Public methodWhereIn(String, ICollectionGuid)
Adds where condition to the list of values, e.g. "columnName IN (...)"
Public methodWhereIn(String, ICollectionInt32)
Adds where condition to the list of values, e.g. "columnName IN (...)"
Public methodWhereIn(String, ICollectionInt64)
Adds where condition to the list of values, e.g. "columnName IN (...)"
Public methodWhereIn(String, ICollectionString)
Adds where condition to the list of values, e.g. "columnName IN (...)"
Protected methodWhereIn(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!
Protected methodWhereIn(String, ICollectionGuid, Boolean)
Adds where condition to the list of values, e.g. "columnName IN (...)"
Protected methodWhereIn(String, ICollectionInt32, Boolean)
Adds where condition to the list of values, e.g. "columnName IN (...)"
Protected methodWhereIn(String, ICollectionInt64, Boolean)
Adds where condition to the list of values, e.g. "columnName IN (...)"
Protected methodWhereIn(String, ICollectionString, Boolean)
Adds where condition to the list of values, e.g. "columnName IN (...)"
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.
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.
Public methodWhereLessThan(String, Object)
Adds the given where condition to the query. Matches the left side which is less than the right side.
Public methodWhereLessThan(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side which is less than the right side.
Public methodWhereLike(String, String)
Adds the given where condition to the query. Matches the column to a given value using LIKE operator.
Public methodWhereLike(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side and right side using LIKE operator.
Public methodWhereNot
Adds the negation of the given where condition
Public methodWhereNotContains(String, String)
Adds the condition for a string column not to contain some substring
Public methodWhereNotContains(IQueryObjectWithValue, String)
Adds the condition for a string column not to contain some substring
Public methodWhereNotEmpty
Adds the where condition for a non empty column value
Public methodWhereNotEndsWith(String, String)
Adds the condition for a string column not to end with some prefix
Public methodWhereNotEndsWith(IQueryObjectWithValue, String)
Adds the condition for a string column not to end with some prefix
Public methodWhereNotEquals(String, Object)
Adds the given where condition to the query. Matches the column which is not equal to a given value.
Public methodWhereNotEquals(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side which is not equal to the right side.
Public methodWhereNotExists
Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)"
Public methodWhereNotIn(String, IDataQuery)
Adds where condition to the nested query, e.g. "columnName NOT IN (...)"
Public methodWhereNotIn(String, ICollectionGuid)
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
Public methodWhereNotIn(String, ICollectionInt32)
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
Public methodWhereNotIn(String, ICollectionInt64)
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
Public methodWhereNotIn(String, ICollectionString)
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
Public methodWhereNotLike(String, String)
Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator.
Public methodWhereNotLike(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side and right side using NOT LIKE operator.
Public methodWhereNotNull(String)
Adds the where condition for a not null column value
Public methodWhereNotNull(IQueryObjectWithValue)
Adds the where condition for a not null expression value
Public methodWhereNotStartsWith(String, String)
Adds the condition for a string column not to start with some prefix
Public methodWhereNotStartsWith(IQueryObjectWithValue, String)
Adds the condition for a string column not to start with some prefix
Public methodWhereNull(String)
Adds the where condition for a null column value
Public methodWhereNull(IQueryObjectWithValue)
Adds the where condition for a null expression value
Public methodWhereStartsWith(String, String)
Adds the condition for a string column to start with some prefix
Public methodWhereStartsWith(IQueryObjectWithValue, String)
Adds the condition for a string column to start with some prefix
Public methodWhereTrue(String)
Adds the where condition for a true column value (boolean column equals true).
Public methodWhereTrue(IQueryObjectWithValue)
Adds the where condition for a true expression value (boolean expression equals true).
Top
Extension Methods
See Also