QueryParametersBase<TParent> Class

Generic variant of the abstract query object, provides fluent syntax

Inheritance Hierarchy

System.Object
  CMS.Base.DisposableObject
    CMS.DataEngine.AbstractQueryObject
      CMS.DataEngine.QueryParametersBase<TParent>
        CMS.DataEngine.QueryColumnBase<TColumn>
        CMS.DataEngine.QueryExpressionBase<TExpression>
        CMS.DataEngine.QuerySourceBase<TSource>
        CMS.DataEngine.WhereConditionBase<TParent>

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

Syntax

public abstract class QueryParametersBase<TParent> : AbstractQueryObject, 
	IQueryParameters<TParent>, IQueryParameters, IQueryObject
where TParent : new(), QueryParametersBase<TParent>

Type Parameters

TParent

The QueryParametersBase<TParent> type exposes the following members.

Constructors

	Name	Description
Protected method	QueryParametersBase<TParent>

Fields

	Name	Description
Protected field	mParameters	Query data parameters

Properties

	Name	Description
Protected property	IsImmutable	If true, this object instance is immutable, and next subsequent modification starts with a clone of the object.
Public property	Name	Object name, empty by default (Inherited from AbstractQueryObject.)
Public property	Parameters	Query data parameters (Overrides AbstractQueryObject.Parameters.)

Methods

	Name	Description
Public method	ApplyParametersTo	Applies this where condition to the target object (Overrides AbstractQueryObject.ApplyParametersTo(IQueryObject).)
Public method	CallOnDispose	Adds the given action to the list of actions called when the handler object is disposed (Inherited from DisposableObject.)
Public method	Changed	Marks the object as changed (Inherited from AbstractQueryObject.)
Public method	Clone	Creates the clone of the object.
Public method	CloneObject	Creates the clone of the object. (Overrides AbstractQueryObject.CloneObject().)
Public method	CopyPropertiesTo	Copies all the object properties to the given target class
Public method	Dispose	Make sure the objects get disposed (Inherited from DisposableObject.)
Public method	EnsureParameters	Ensures data parameters for the given query
Public method	Expand	Expands the expression by replacing parameters with their values
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.
Public method	Immutable	Makes this object instance is immutable, and next subsequent modification starts with a clone of the object.
Public method	IncludeDataParameters	Adds the data parameters to the current query parameters (Overrides AbstractQueryObject.IncludeDataParameters(QueryDataParameters, String).)
Public method	Lock	Locks the event on the given lock object. The context stays locked until the handler is disposed. (Inherited from DisposableObject.)
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.)
Public method	Snapshot	Creates an immutable snapshot of the current query as a base for further evaluation. Doesn't modify the original query in any way.
Public method	ToString()	Returns the string representation of the expression (Overrides Object.ToString().)
Public method	ToString(Boolean)	Returns the string representation of the expression, with possibility of expanding parameters
Public method	Using	Adds the given object to the list of the allocated objects to dispose (Inherited from DisposableObject.)