Table of Contents

Interface IInfoObjectCollection

Namespace
CMS.DataEngine
Assembly
CMS.DataEngine.dll

Interface for info object collection

public interface IInfoObjectCollection : INamedEnumerable, IIndexable, INameIndexable, IVirtualTypedCollection, ICMSQueryable
Inherited Members
Extension Methods

Properties

AllowPaging

If true, the paging of the data is allowed (data is loaded in batches).

bool AllowPaging { get; set; }

Property Value

bool

CodeNames

Collection of the object code names

CollectionPropertyWrapper<BaseInfo> CodeNames { get; }

Property Value

CollectionPropertyWrapper<BaseInfo>

Columns

Columns to get.

string Columns { get; set; }

Property Value

string

DisplayNames

Collection of the object display names

CollectionPropertyWrapper<BaseInfo> DisplayNames { get; }

Property Value

CollectionPropertyWrapper<BaseInfo>

DynamicWhereCondition

Dynamic where condition.

Func<string> DynamicWhereCondition { get; set; }

Property Value

Func<string>

EnforceReadOnlyDataAccess

If true, the read only access to the data is enforced within the transaction.

bool EnforceReadOnlyDataAccess { get; set; }

Property Value

bool

FieldsAsObjects

Related objects wrappers

CollectionPropertyTransformation<IInfoObjectCollection> FieldsAsObjects { get; }

Property Value

CollectionPropertyTransformation<IInfoObjectCollection>

GUIDs

Collection of the object GUIDs

CollectionPropertyWrapper<BaseInfo> GUIDs { get; }

Property Value

CollectionPropertyWrapper<BaseInfo>

IDs

Collection of the object IDs

CollectionPropertyWrapper<BaseInfo> IDs { get; }

Property Value

CollectionPropertyWrapper<BaseInfo>

IsLastVersion

If true, the document is the last version (retrieved using DocumentHelper.GetDocument).

bool IsLastVersion { get; set; }

Property Value

bool

ItemsAsFields

Fields wrappers

CollectionPropertyTransformation<CollectionPropertyWrapper<BaseInfo>> ItemsAsFields { get; }

Property Value

CollectionPropertyTransformation<CollectionPropertyWrapper<BaseInfo>>

LoadBinaryData

Gets or sets the value which indicates whether to load binary data into the collections.

bool LoadBinaryData { get; set; }

Property Value

bool

Name

Collection name

string Name { get; set; }

Property Value

string

NameColumn

Name column name

string NameColumn { get; set; }

Property Value

string

Object

Object instance of the specified type.

BaseInfo Object { get; set; }

Property Value

BaseInfo

ObjectType

Returns the object type of the objects stored within the collection.

string ObjectType { get; }

Property Value

string

OrderByColumns

Columns list of SQL order by expression (e.g.: 'UserName, UserID DESC')

string OrderByColumns { get; set; }

Property Value

string

ParentObject

Parent object. Instance of object which contains this collection as it's inner field.

BaseInfo ParentObject { get; }

Property Value

BaseInfo

SourceData

Source data for the collection

DataSet SourceData { get; set; }

Property Value

DataSet

TopN

Select top N objects.

int TopN { get; set; }

Property Value

int

TypeInfo

Type info for the collection object.

ObjectTypeInfo TypeInfo { get; }

Property Value

ObjectTypeInfo

UseDefaultCacheDependencies

If true, the collection uses default cache dependencies to flush it's content

bool UseDefaultCacheDependencies { get; set; }

Property Value

bool

UseObjectTypeCondition

If true, the collection uses the type condition to get the data

bool UseObjectTypeCondition { get; set; }

Property Value

bool

Where

Where condition.

WhereCondition Where { get; set; }

Property Value

WhereCondition

Methods

Add(params BaseInfo[])

Adds new object to the collection.

void Add(params BaseInfo[] objects)

Parameters

objects BaseInfo[]

Objects to add

Add(IEnumerable<BaseInfo>)

Adds new object to the collection.

void Add(IEnumerable<BaseInfo> objects)

Parameters

objects IEnumerable<BaseInfo>

Object to add

As<TType>()

Makes a wrapper of the collection with specified type of the items.

IQueryable<TType> As<TType>() where TType : BaseInfo

Returns

IQueryable<TType>

Type Parameters

TType

Target type of the items

ChangeParent(BaseInfo, ICMSStorage)

Changes the parent of the collection

void ChangeParent(BaseInfo parentObject, ICMSStorage parentStorage)

Parameters

parentObject BaseInfo

Parent object

parentStorage ICMSStorage

Parent storage

ClearCache()

Clears the collection cache

void ClearCache()

CloneCollection()

Creates the clone of this collection.

IInfoObjectCollection CloneCollection()

Returns

IInfoObjectCollection

Disconnect()

Disconnects the collection from the database

void Disconnect()

GetFieldsAsObjects(string)

Gets the collection of objects that are referenced by the given property

IInfoObjectCollection GetFieldsAsObjects(string propertyName)

Parameters

propertyName string

Property name

Returns

IInfoObjectCollection

GetItemsAsFields(string)

Returns the updatable collection of fields of collection items

CollectionPropertyWrapper<BaseInfo> GetItemsAsFields(string propertyName)

Parameters

propertyName string

Name of the properties to extract

Returns

CollectionPropertyWrapper<BaseInfo>

Load(IEnumerable<BaseInfo>)

Clears the data in the collection and loads objects from the given list.

void Load(IEnumerable<BaseInfo> objects)

Parameters

objects IEnumerable<BaseInfo>

Objects data to load

SubmitChanges()

Submits the changes in the collection to the database.

void SubmitChanges()