Class AbstractQueryObject

Namespace

CMS.DataEngine

Assembly

CMS.DataEngine.dll

Base for any object participating in the Data query evaluation

public abstract class AbstractQueryObject : IQueryObject

Inheritance

object

AbstractQueryObject

Implements

IQueryObject

Derived

QueryParametersBase<TParent>

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Properties

Name

Object name, empty by default

public virtual string Name { get; }

Property Value

string

Parameters

Query parameters

public abstract QueryDataParameters Parameters { get; set; }

Property Value

QueryDataParameters

Methods

ApplyParametersTo(IQueryObject)

Applies this query parameters to the target object

public abstract void ApplyParametersTo(IQueryObject target)

Parameters

target IQueryObject

Target object defining parameters

Changed()

Marks the object as changed

public virtual void Changed()

CloneObject()

Creates the clone of the object.

public abstract IQueryObject CloneObject()

Returns

IQueryObject

IncludeDataParameters(QueryDataParameters, string)

Adds the data parameters to the current query parameters

public abstract string IncludeDataParameters(QueryDataParameters parameters, string expression)

Parameters

parameters QueryDataParameters

Parameters to add

expression string

Expression which refers to the parameters

Returns

string

Reset()

Flushes the results but leaves the generated query text unchanged. After the reset, query can be executed again to obtain new data.

public virtual void Reset()