IWhereCondition<TParent> Interface

Interface for classes which provide where condition for a specific query type

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

Syntax

public interface IWhereCondition<TParent> : IWhereCondition, 
	IQueryParameters, IQueryObject, IDisposable, IQueryParameters<TParent>

Type Parameters

TParent

The IWhereCondition<TParent> type exposes the following members.

Properties

	Name	Description
Public property	DataSourceName	Data source identifier that represents the location from which the data are obtained. (Inherited from IWhereCondition.)
Public property	Name	Object name, empty by default (Inherited from IQueryObject.)
Public property	Parameters	Query data parameters (Inherited from IQueryObject.)
Public property	WhereCondition	Where condition on the data, e.g. "DocumentName = 'ABC'" (Inherited from IWhereCondition.)
Public property	WhereIsComplex	Returns true if the given where condition contains compound conditions, e. g. "A > 1 AND B = 5" (Inherited from IWhereCondition.)
Public property	WhereIsEmpty	Returns true if the where condition is empty (Inherited from IWhereCondition.)

Methods

	Name	Description
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.
Public method	ApplyParametersTo	Applies this where condition to the target object (Inherited from IQueryParameters.)
Public method	Changed	Marks the object as changed (Inherited from IQueryObject.)
Public method	CloneObject	Creates the clone of the object. (Inherited from IQueryObject.)
Public method	CopyPropertiesTo	Copies the properties to the target query. (Inherited from IQueryParameters.)
Public method	EnsureParameters	Ensures data parameters for the given query (Inherited from IQueryParameters.)
Public method	Expand	Expands the expression by replacing parameters with their values (Inherited from IQueryParameters.)
Public method	GetTypedQuery	Returns specifically typed instance of current Query object to allow user to compose Query in fluent syntax. (Inherited from IQueryParameters<TParent>.)
Public method	IncludeDataParameters	Adds the data parameters to the current query parameters (Inherited from IQueryObject.)
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	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.)
Public method	ToString	Returns the string representation of the expression, with possibility of expanding parameters (Inherited from IQueryParameters.)
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(String, QueryOperator, Object)	Adds the given where condition to the query. Matches the column to a given value.
Public method	WhereContains	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	WhereEquals	Adds the given where condition to the query. Matches the column to a given value.
Public method	WhereEqualsOrNull	Adds the given where condition to the query. Matches the column to a given value or null value.
Public method	WhereExists	Adds where condition with EXISTS and the nested query "EXISTS (...)"
Public method	WhereFalse	Adds the where condition for a false column value (boolean column equals false).
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<String>)	Adds where condition to the list of values, e.g. "columnName IN (...)"
Public method	WhereLike	Adds the given where condition to the query. Matches the column to a given value using LIKE operator.
Public method	WhereNot	Adds the negation of the given where condition
Public method	WhereNotContains	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	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<String>)	Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
Public method	WhereNotLike	Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator.
Public method	WhereNotNull	Adds the where condition for a not null column value
Public method	WhereNotStartsWith	Adds the condition for a string column not to start with some prefix
Public method	WhereNull	Adds the where condition for a null column value
Public method	WhereStartsWith	Adds the condition for a string column to start with some prefix
Public method	WhereTrue	Adds the where condition for a true column value (boolean column equals true).