WhereConditionBase<TParent> Class

Where condition builder - Generic base class

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractQueryObject
    CMS.DataEngine.QueryParametersBase<TParent>
      CMS.DataEngine.WhereConditionBase<TParent>
        CMS.DataEngine.DataQuerySettingsBase<TQuery>
        CMS.DataEngine.WhereCondition

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 13.0.131

Syntax

public abstract class WhereConditionBase<TParent> : QueryParametersBase<TParent>, 
	IWhereCondition<TParent>, IWhereCondition, IQueryParameters, IQueryObject, IQueryParameters<TParent>, 
	IEquatable<TParent>
where TParent : new(), WhereConditionBase<TParent>

Type Parameters

TParent

The WhereConditionBase<TParent> type exposes the following members.

Constructors

	Name	Description
Protected method	WhereConditionBase<TParent>	Default constructor

Fields

	Name	Description
Protected field	mParameters	Query data parameters (Inherited from QueryParametersBase<TParent>.)

Properties

	Name	Description
Public property	DataSourceName	Data source identifier that represents the location from which the data are obtained.
Protected property	IsImmutable	If true, this object instance is immutable, and next subsequent modification starts with a clone of the object. (Inherited from QueryParametersBase<TParent>.)
Public property	Name	Object name, empty by default (Inherited from AbstractQueryObject.)
Public property	Parameters	Query data parameters (Inherited from QueryParametersBase<TParent>.)
Public property	ReturnsNoResults	Returns true if query doesn't return any results
Protected property	WhereBuilder	Where condition builder
Public property	WhereCondition	Where condition on the data, e.g. "DocumentName = 'ABC'"
Public property	WhereIsComplex	Returns true if the given where condition contains compound conditions, e. g. "A > 1 AND B = 5"
Public property	WhereIsEmpty	Returns true if the where condition is empty
Protected property	WhereOperator	Operator used for adding where condition. Default is AND

Methods

	Name	Description
Protected method	AddWhereCondition	Adds the given where condition to the final where condition
Protected method	AddWhereConditionInternal	Adds the given where condition
Public method	And()	Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where...
Public method	And(IWhereCondition)	Adds the given where condition with the AND operator
Public method	And(Action<WhereCondition>)	Adds the given where condition with the AND operator. Creates a new where condition object and runs the setup actions on it.
Protected method	AnySettingsDefined	Returns true if the object has any settings defined that influence the resulting query
Public method	ApplyParametersTo	Applies this where condition to the target object (Overrides QueryParametersBase<TParent>.ApplyParametersTo(IQueryObject).)
Public method	Changed	Marks the object as changed (Inherited from AbstractQueryObject.)
Protected method	CheckReturnsNoResults	Checks if where condition results in no data
Public method	Clone	Creates the clone of the object. (Inherited from QueryParametersBase<TParent>.)
Public method	CloneObject	Creates the clone of the object. (Inherited from QueryParametersBase<TParent>.)
Public method	CopyPropertiesTo	Creates the clone of the collection. (Overrides QueryParametersBase<TParent>.CopyPropertiesTo(IQueryObject).)
Public method	EnsureParameters	Ensures data parameters for the given query (Inherited from QueryParametersBase<TParent>.)
Public method	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Overrides Object.Equals(Object).)
Public method	Equals(TParent)	Indicates whether the current object is equal to another object of the same type.
Public method	Expand	Expands the expression by replacing parameters with their values (Inherited from QueryParametersBase<TParent>.)
Protected method Static member	GetContainsPattern	Gets the contains pattern for the like expression
Protected method	GetDataSourceName	Gets data source identifier that represents the location from which the data are obtained.
Public method	GetHashCode	Serves as a hash function for a particular type. (Overrides Object.GetHashCode().)
Public method	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 QueryParametersBase<TParent>.)
Protected method	GetWhere(String, QueryOperator, Object)	Gets the where condition for the given column
Protected method	GetWhere(IQueryObjectWithValue, QueryOperator, Object)	Gets the where condition for the given column
Public method	HasCompatibleSource	Returns true if the given query is an external source
Public method	Immutable	Makes this object instance immutable, and next subsequent modification starts with a clone of the object. (Inherited from QueryParametersBase<TParent>.)
Public method	IncludeDataParameters	Adds the data parameters to the current query parameters (Inherited from QueryParametersBase<TParent>.)
Public method	NewWhere	Clears the current where condition
Public method	NoResults	Sets the where condition to exclude all data from result
Public method	Or()	Changes the where operator to OR for next where conditions. Use in combination of methods Where...
Public method	Or(IWhereCondition)	Adds the given where condition with the OR operator
Public method	Or(Action<WhereCondition>)	Adds the given where condition with the OR operator. Creates a new where condition object and runs the setup actions on it.
Public method	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.)
Protected method	ResetWhereOperator	Resets the where operator to the default value
Public method	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.
Public method	Snapshot	Obsolete. 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 method	ToString()	Returns the string representation of the expression (Inherited from QueryParametersBase<TParent>.)
Public method	ToString(Boolean)	Returns the string representation of the expression, with possibility of expanding parameters (Overrides QueryParametersBase<TParent>.ToString(Boolean).)
Public method	Where(IWhereCondition[])	Adds the given where conditions to the query
Public method	Where(Action<WhereCondition>)	Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it.
Public method	Where(String, QueryDataParameters)	Adds the given where condition to the query
Public method	Where(String, QueryUnaryOperator)	Adds the given where condition to the query. Matches the column value with an unary operator.
Public method	Where(IQueryObjectWithValue, QueryUnaryOperator)	Adds the given where condition to the query. Matches the column value with an unary operator.
Public method	Where(String, QueryOperator, Object)	Adds the given where condition to the query. Matches the column to a given value.
Public method	Where(IQueryObjectWithValue, QueryOperator, Object)	Adds the given where condition to the query. Matches the column to a given value.
Public method	WhereContains(String, String)	Adds the condition for a string column to contain some substring
Public method	WhereContains(IQueryObjectWithValue, String)	Adds the condition for a string column to contain some substring
Public method	WhereEmpty	Adds the where condition for a null or empty column value
Public method	WhereEndsWith(String, String)	Adds the condition for a string column to end with some prefix
Public method	WhereEndsWith(IQueryObjectWithValue, String)	Adds the condition for a string expression to end with some prefix
Public method	WhereEquals(String, Object)	Adds the given where condition to the query. Matches the column to a given value.
Public method	WhereEquals(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side to the given right side.
Public method	WhereEqualsOrNull	Adds the given where condition to the query. Matches the column to a given value or null value.
Public method	WhereExists(IDataQuery)	Adds where condition with EXISTS and the nested query "EXISTS (...)"
Protected method	WhereExists(IDataQuery, Boolean)	Adds where condition with EXISTS and the nested query "EXISTS (...)"
Public method	WhereFalse(String)	Adds the where condition for a false column value (boolean column equals false).
Public method	WhereFalse(IQueryObjectWithValue)	Adds the where condition for a false expression value (boolean expression equals false).
Public method	WhereGreaterOrEquals(String, Object)	Adds the given where condition to the query. Matches the left side which is greater or equal than the right side.
Public method	WhereGreaterOrEquals(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side which is greater or equal than the right side.
Public method	WhereGreaterThan(String, Object)	Adds the given where condition to the query. Matches the left side which is greater than the right side.
Public method	WhereGreaterThan(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side which is greater than the right side.
Public method	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.
Public method	WhereIn(String, IDataQuery)	Adds where condition to the nested query, e.g. "columnName IN (...)"
Public method	WhereIn(String, ICollection<Guid>)	Adds where condition to the list of values, e.g. "columnName IN (...)"
Public method	WhereIn(String, ICollection<Int32>)	Adds where condition to the list of values, e.g. "columnName IN (...)"
Public method	WhereIn(String, ICollection<Int64>)	Adds where condition to the list of values, e.g. "columnName IN (...)"
Public method	WhereIn(String, ICollection<String>)	Adds where condition to the list of values, e.g. "columnName IN (...)"
Protected method	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!
Protected method	WhereIn(String, ICollection<Guid>, Boolean)	Adds where condition to the list of values, e.g. "columnName IN (...)"
Protected method	WhereIn(String, ICollection<Int32>, Boolean)	Adds where condition to the list of values, e.g. "columnName IN (...)"
Protected method	WhereIn(String, ICollection<Int64>, Boolean)	Adds where condition to the list of values, e.g. "columnName IN (...)"
Protected method	WhereIn(String, ICollection<String>, Boolean)	Adds where condition to the list of values, e.g. "columnName IN (...)"
Public method	WhereLessOrEquals(String, Object)	Adds the given where condition to the query. Matches the left side which is less or equal than the right side.
Public method	WhereLessOrEquals(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side which is less or equal than the right side.
Public method	WhereLessThan(String, Object)	Adds the given where condition to the query. Matches the left side which is less than the right side.
Public method	WhereLessThan(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side which is less than the right side.
Public method	WhereLike(String, String)	Adds the given where condition to the query. Matches the column to a given value using LIKE operator.
Public method	WhereLike(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side and right side using LIKE operator.
Public method	WhereNot	Adds the negation of the given where condition
Public method	WhereNotContains(String, String)	Adds the condition for a string column not to contain some substring
Public method	WhereNotContains(IQueryObjectWithValue, String)	Adds the condition for a string column not to contain some substring
Public method	WhereNotEmpty	Adds the where condition for a non empty column value
Public method	WhereNotEndsWith(String, String)	Adds the condition for a string column not to end with some prefix
Public method	WhereNotEndsWith(IQueryObjectWithValue, String)	Adds the condition for a string column not to end with some prefix
Public method	WhereNotEquals(String, Object)	Adds the given where condition to the query. Matches the column which is not equal to a given value.
Public method	WhereNotEquals(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side which is not equal to the right side.
Public method	WhereNotExists	Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)"
Public method	WhereNotIn(String, IDataQuery)	Adds where condition to the nested query, e.g. "columnName NOT IN (...)"
Public method	WhereNotIn(String, ICollection<Guid>)	Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
Public method	WhereNotIn(String, ICollection<Int32>)	Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
Public method	WhereNotIn(String, ICollection<Int64>)	Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
Public method	WhereNotIn(String, ICollection<String>)	Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
Public method	WhereNotLike(String, String)	Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator.
Public method	WhereNotLike(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side and right side using NOT LIKE operator.
Public method	WhereNotNull(String)	Adds the where condition for a not null column value
Public method	WhereNotNull(IQueryObjectWithValue)	Adds the where condition for a not null expression value
Public method	WhereNotStartsWith(String, String)	Adds the condition for a string column not to start with some prefix
Public method	WhereNotStartsWith(IQueryObjectWithValue, String)	Adds the condition for a string column not to start with some prefix
Public method	WhereNull(String)	Adds the where condition for a null column value
Public method	WhereNull(IQueryObjectWithValue)	Adds the where condition for a null expression value
Public method	WhereStartsWith(String, String)	Adds the condition for a string column to start with some prefix
Public method	WhereStartsWith(IQueryObjectWithValue, String)	Adds the condition for a string column to start with some prefix
Public method	WhereTrue(String)	Adds the where condition for a true column value (boolean column equals true).
Public method	WhereTrue(IQueryObjectWithValue)	Adds the where condition for a true expression value (boolean expression equals true).

Extension Methods

	Name	Description
Public Extension Method	WhereNotExpired<TQuery>	Filters out objects which have their 'Expiration' column's day (e.g. Expiration) before currentDateTime. (Defined by ScoreContactRuleInfoObjectQueryExtensions.)