IWhereCondition Interface

Interface for classes which provide where condition

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

Syntax

public interface IWhereCondition : IQueryParameters, 
	IQueryObject, IDisposable

The IWhereCondition type exposes the following members.

Properties

	Name	Description
Public property	DataSourceName	Data source identifier that represents the location from which the data are obtained.
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'"
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

Methods

	Name	Description
Public method	ApplyParametersTo	Applies this where condition to the target object (Inherited from IQueryParameters.)
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	Changed	Marks the object as changed (Inherited from IQueryObject.)
Public method	IncludeDataParameters	Adds the data parameters to the current query parameters (Inherited from IQueryObject.)
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	ToString	Returns the string representation of the expression, with possibility of expanding parameters (Inherited from IQueryParameters.)