ObjectRepository<TCollection, TObject, TSettings> Class

Repository for info objects.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.ObjectRepository<TCollection, TObject, TSettings>
    CMS.DataEngine.InfoObjectRepository
    CMS.DocumentEngine.DocumentRepository

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

Syntax

public abstract class ObjectRepository<TCollection, TObject, TSettings> : INamedEnumerable<TCollection>, 
	INamedEnumerable, IEnumerable<TCollection>, IEnumerable, IHierarchicalObject, 
	INameIndexable
where TCollection : AbstractObjectCollection, IEnumerable<TObject>
where TSettings : BaseCollectionSettings

Type Parameters

TCollection

TObject

TSettings

The ObjectRepository<TCollection, TObject, TSettings> type exposes the following members.

Constructors

	Name	Description
Public method	ObjectRepository<TCollection, TObject, TSettings>	Constructor

Methods

	Name	Description
Public method	Disconnect	Disconnects the collections from the database
Protected method	GetCollection	Returns the collection of objects indexed by object type, e.g. "cms.user".
Public method	GetEnumerator	Gets the enumerator for the collection.
Public method	GetNicePropertyName	Gets the property name for the original name of the collection
Public method	GetObjectName	Returns the name of the given object
Public method	GetProperty	Gets the property value.
Protected method	LoadCollection	Loads the given collection.
Public method	NewCollection	Creates new collection for the data.
Public method	NewCombinedCollection	Creates new combined collection for the data.
Public method	Reconnect	Reconnects the collection to the database
Protected method	RegisterNiceName	Registers the nice name of the collection
Public method	TryGetProperty	Returns value of property.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	Batch<TCollection>	Returns input in batches of batchSize size. (Defined by BaseExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetNamedEnumerator<T>	Name enumerator over a collection (Defined by DataExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToHashSet<TCollection>	Converts the list of objects to a hash set of distinct values (Defined by DataExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IEnumerable. (Defined by DataExtensions.)
Public Extension Method	ToList<TCollection, TTo>	Converts the given collection to a list of values (Defined by BaseExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToXML	Returns XML representation of current instance of IEnumerable. (Defined by DataExtensions.)

Fields

	Name	Description
Protected field	mAll	Collection of all underlying objects.
Protected field	mCollections	Table of collections [name -> CollectionType]
Protected field	mCollectionSettings	Table of collection settings [name -> InfoCollectionSettings]
Protected field	mCollectionSettingsByIndex	Table of collection settings by index [index -> InfoCollectionSettings]
Protected field	mCollectionsList	List of all collections (sorted by the order in which the collections were added).
Protected field	mCount	Number of the inner collections.
Protected field	mDisconnectedCount	Number of disconnected references for this collection
Protected field	mDynamicNames	List of dynamic names of the collections
Protected field	mLoadBinaryData	Indicates whether to load binary data into the collections of the repository.
Protected field	mNiceNames	Translation of collection nice names to a normal names [niceName -> name]
Protected field	mProperties	Properties of the object available through GetProperty.

Properties

	Name	Description
Public property	All	All items from all underlying collections.
Public property	AllowNiceNames	If true, the repository allows nice names of the collections, e.g. for "CMS.User" uses "Users"
Public property	CollectionNames	Returns list of collection names in the repository.
Public property	Count	Returns the number of items.
Public property	DynamicNames	List of the dynamic names of the collections
Public property	GetDynamicNames	Function that provides the dynamic names of collections to the repository
Public property	IsCachedObject	If true, the object is cached within the system for later use
Public property	IsDisconnected	Returns true if this collection is disconnected from the database
Public property	Item[Int32]	Returns the collection of objects.
Public property	Item[String]	Returns the collection of objects indexed by object type, e.g. "cms.user".
Public property	ItemsHaveNames	Returns true if the items in the collection have names
Public property	LoadBinaryData	Gets or sets the value which indicates whether to load binary data into the collections.
Public property	ParentStorage	Parent storage
Public property	Properties	Properties of the object available through GetProperty.
Public property	SortNames	If true, the names in enumeration are sorted

Events

	Name	Description
Public event	OnLoadCollection	Fires when the collection with specified name is requested.