Table of Contents

Class QueryInfo

Namespace
CMS.DataEngine
Assembly
CMS.DataEngine.dll

Represents a query and its parameters.

[InfoCache(InfoCacheBy.ID|InfoCacheBy.FullName, LoadEagerly = true, Priority = InfoCachePriority.NotRemovable)]
public class QueryInfo : AbstractInfo<QueryInfo, IQueryInfoProvider>, IExtensible, IInfo, IAdvancedDataContainer, ICMSObject, IHierarchicalDataContainer, IDataContainer, ISimpleDataContainer, IVirtualHierarchicalObject, IHierarchicalObject, INameIndexable, IMacroObject, IInfoWithId
Inheritance
object
QueryInfo
Implements
Inherited Members
Extension Methods

Constructors

QueryInfo()

Constructor, creates an empty Query structure.

public QueryInfo()

QueryInfo(ObjectTypeInfo)

Constructor, creates an empty Query structure.

protected QueryInfo(ObjectTypeInfo typeInfo)

Parameters

typeInfo ObjectTypeInfo

QueryInfo(ObjectTypeInfo, DataRow)

Constructor - Creates a new QueryInfo object from the given DataRow.

public QueryInfo(ObjectTypeInfo typeInfo, DataRow dr)

Parameters

typeInfo ObjectTypeInfo

Type info

dr DataRow

DataRow with the object data

QueryInfo(DataRow)

Constructor, creates the Query object from the given DataRow data.

public QueryInfo(DataRow dr)

Parameters

dr DataRow

Data row with the Query info data

Fields

OBJECT_TYPE

Object type

public const string OBJECT_TYPE = "cms.query"

Field Value

string

TYPEINFO

Type information.

public static ObjectTypeInfo TYPEINFO

Field Value

ObjectTypeInfo

Properties

ClassID

Class ID

[DatabaseField]
public virtual int ClassID { get; set; }

Property Value

int

ObjectDisplayName

Object name.

protected override string ObjectDisplayName { get; }

Property Value

string

ObjectFullName

Object full name if defined

protected override string ObjectFullName { get; }

Property Value

string

QueryClassName

Query class name.

public string QueryClassName { get; }

Property Value

string

QueryConnectionString

Query connection string name

[DatabaseField]
public virtual string QueryConnectionString { get; set; }

Property Value

string

QueryFullName

Query full name.

public string QueryFullName { get; }

Property Value

string

QueryGUID

Query GUID

[DatabaseField]
public virtual Guid QueryGUID { get; set; }

Property Value

Guid

QueryID

Query ID

[DatabaseField]
public virtual int QueryID { get; set; }

Property Value

int

QueryIsCustom

Query is custom

[DatabaseField]
public virtual bool QueryIsCustom { get; set; }

Property Value

bool

QueryIsLocked

Query is locked

[Obsolete("Property is deprecated and will be removed in next version.")]
[ObsoleteSince(28, 2)]
public virtual bool QueryIsLocked { get; set; }

Property Value

bool

QueryLastModified

Query last modified

[DatabaseField]
public virtual DateTime QueryLastModified { get; set; }

Property Value

DateTime

QueryName

Query name

[DatabaseField]
public virtual string QueryName { get; set; }

Property Value

string

QueryRequiresTransaction

Query requires transaction

[DatabaseField]
public virtual bool QueryRequiresTransaction { get; set; }

Property Value

bool

QueryText

Query text

[DatabaseField]
public virtual string QueryText { get; set; }

Property Value

string

QueryType

Query type (SQL command or stored procedure).

public QueryTypeEnum QueryType { get; set; }

Property Value

QueryTypeEnum

QueryTypeID

Query type ID

[DatabaseField]
public virtual int QueryTypeID { get; set; }

Property Value

int

Methods

DeleteObject()

Deletes the object using appropriate provider.

protected override void DeleteObject()

LoadData(LoadDataSettings)

Loads the object data from given data container.

protected override void LoadData(LoadDataSettings settings)

Parameters

settings LoadDataSettings

Data settings

LoadDefaultData()

Loads the default data to the object.

protected override void LoadDefaultData()

SetObject()

Updates the object using appropriate provider.

protected override void SetObject()