ProviderInfoDictionary<KeyType> Class

Base info dictionary for info providers

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractProviderDictionary
    CMS.DataEngine.ProviderDictionary<KeyType, BaseInfo>
      CMS.DataEngine.ProviderInfoDictionary<KeyType>
        CMS.DataEngine.ProviderGuidDictionary
        CMS.DataEngine.ProviderIntDictionary

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

Syntax

public class ProviderInfoDictionary<KeyType> : ProviderDictionary<KeyType, BaseInfo>

Type Parameters

KeyType

The ProviderInfoDictionary<KeyType> type exposes the following members.

Constructors

	Name	Description
Public method	ProviderInfoDictionary<KeyType>	Constructor.

Methods

	Name	Description
Public method	Add(TKey, TValue)	Adds the specified object. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Add(KeyType, BaseInfo, Boolean)	Adds the specified object. (Overrides ProviderDictionary<TKey, TValue>.Add(TKey, TValue, Boolean).)
Public method	Clear	Clears all the items. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	ClearExpired	Clears all the expired items. (Inherited from ProviderDictionary<TKey, TValue>.)
Protected method	ClearInternal	Clears the internal dictionary (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	ClearOlder	Removes the objects older that specified time. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Contains(Object)	Returns true if the table contains specified record. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Contains(TKey)	Returns true if the table contains specified record. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Contains(Object, TValue)	Returns true if the table contains specified record. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Contains(TKey, TValue)	Returns true if the table contains specified record. (Inherited from ProviderDictionary<TKey, TValue>.)
Protected method	ContainsInternal	Returns true if the internal dictionary contains specified record. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	ContainsKey	Returns true if the table contains specified record. (Inherited from ProviderDictionary<TKey, TValue>.)
Protected method	ConvertKey	Converts the key to a specific type (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Delete	Removes the specified object and logs the web farm task. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	GetRealCount	Gets the real count of the objects in the dictionary (Inherited from ProviderDictionary<TKey, TValue>.)
Protected method	CheckLogTask	Returns true if the logging of the tasks is enabled for the given object (Overrides ProviderDictionary<TKey, TValue>.CheckLogTask(TValue).)
Public method	Invalidate	Invalidates the dictionary content. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	LoadNextGeneration	Loads the next generation of the objects. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	LogWebFarmTask(String, String)	Logs the web farm task with specified task data. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	LogWebFarmTask(TKey, String)	Logs the web farm task for specified object key. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	NextGenerationAvailable	Returns true if the next generation of the objects is available. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Remove(Object)	Removes the specified object. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Remove(TKey)	Removes the specified object. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Remove(TKey, Boolean)	Removes the specified object. (Inherited from ProviderDictionary<TKey, TValue>.)
Protected method	RemoveInternal	Removes the key from the internal dictionary (Inherited from ProviderDictionary<TKey, TValue>.)
Protected method	TryGetInternal	Returns true if the internal dictionary contains specified record. (Overrides ProviderDictionary<TKey, TValue>.TryGetInternal(TKey, TValue).)
Public method	Update	Updates the specified object and logs the web farm task. (Inherited from ProviderDictionary<TKey, TValue>.)

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	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
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	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	DefaultWebFarmTaskType	Web farm task type to log (Inherited from ProviderDictionary<TKey, TValue>.)
Protected field	mDataIsValid	True if the dictionary content is valid. (Inherited from ProviderDictionary<TKey, TValue>.)
Protected field	mDictionary	Inner dictionary. (Inherited from ProviderDictionary<TKey, TValue>.)
Protected field	mEnabled	If true, the provider functionality is enabled. (Inherited from ProviderDictionary<TKey, TValue>.)
Protected field	mLogWebFarmTasks	Logs web farm tasks. (Inherited from ProviderDictionary<TKey, TValue>.)
Protected field	mObjectLatency	Object latency of the hashtable. (Inherited from ProviderDictionary<TKey, TValue>.)
Public field	mParentCollection	Parent dictionary collection. (Inherited from ProviderDictionary<TKey, TValue>.)
Protected field	mReloadDictionary	If true, the dictionary should be reloaded. (Inherited from ProviderDictionary<TKey, TValue>.)

Properties

	Name	Description
Public property	ColumnNames	Column names (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	Count	Items count (all keys). (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	DataIsValid	Returns true if the dictionary content is valid. (Inherited from ProviderDictionary<TKey, TValue>.)
Protected property	Dictionary	Inner dictionary. (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	Enabled	If true, the dictionary is enabled. (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	CheckValidity	If true (default), the dictionary checks the validity of the object upon its retrieval and doesn't return invalid objects. The object must support invalidation in order to support this.
Public property	IsEmpty	Returns true if the Dictionary is empty. (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	Item	Dictionary indexer. (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	LogWebFarmTasks	Gets / sets if the dictionary should log web farm tasks (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	Name	Dictionary name. (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	ObjectLatency	Object latency in minutes. (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	ObjectType	Object type (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	ParentCollection	Parent dictionary collection. (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	ReloadDictionary	If true, the dictionary should be reloaded. (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	RemovedValue	Value that is set to the specific key if the value is removed. If not set, the item is completely removed. (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	UseWeakReferences	If true, the weak references are used for the items so the memory can be cleared upon request (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	Values	Returns the values of the dictionary (Inherited from ProviderDictionary<TKey, TValue>.)