AbstractInfoProvider<TInfo, TProvider> Class

Abstract info class provider.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractProvider
    CMS.DataEngine.BaseAbstractInfoProvider
      CMS.DataEngine.AbstractInfoProvider<TProvider>
        CMS.DataEngine.AbstractInfoProvider<TInfo, TProvider>
          More...

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

Syntax

public abstract class AbstractInfoProvider<TInfo, TProvider> : AbstractInfoProvider<TProvider>
where TInfo : new(), AbstractInfo<TInfo>
where TProvider : new(), AbstractInfoProvider<TInfo, TProvider>

Type Parameters

TInfo

TProvider

The AbstractInfoProvider<TInfo, TProvider> type exposes the following members.

Constructors

	Name	Description
Protected method	AbstractInfoProvider<TInfo, TProvider>()	Default constructor.
Protected method	AbstractInfoProvider<TInfo, TProvider>(Boolean)	Default constructor.
Protected method	AbstractInfoProvider<TInfo, TProvider>(ObjectTypeInfo, HashtableSettings)	Default constructor.

Methods

	Name	Description
Public method	AddSiteWhereCondition(String, Int32, String, Boolean)	Creates site where condition from the specified parameters and adds it to the original where condition.
Public method	AddSiteWhereCondition(String, Int32, String, Boolean, String)	Creates site where condition from the specified parameters and adds it to the original where condition.
Protected method	BoundGetInfoByGuid(Guid)	Gets the info object by its GUID (Overrides BaseAbstractInfoProvider.BoundGetInfoByGuid(Guid).)
Protected method	BoundGetInfoByGuid(Guid, Int32)	Gets the info object by its GUID and site ID (Overrides BaseAbstractInfoProvider.BoundGetInfoByGuid(Guid, Int32).)
Protected method	BoundGetInfoById	Gets the info by ID. (Overrides BaseAbstractInfoProvider.BoundGetInfoById(Int32).)
Protected method	BoundGetInfoByName(String)	Gets the info object by its code name (Overrides BaseAbstractInfoProvider.BoundGetInfoByName(String).)
Protected method	BoundGetInfoByName(String, Int32)	Gets the info object by its code name and site Id (Overrides BaseAbstractInfoProvider.BoundGetInfoByName(String, Int32).)
Protected method	BoundGetInfosByIds	Gets the list of info objects by their IDs (Overrides BaseAbstractInfoProvider.BoundGetInfosByIds(IEnumerable<Int32>).)
Protected method	ClearHashtables	Clear hashtables. (Overrides AbstractProvider.ClearHashtables(Boolean).)
Protected method	CreateHashtables	Creates the provider hashtables (Overrides BaseAbstractInfoProvider.CreateHashtables().)
Protected method	CreateInfo(Int32)	Creates an instance of info object.
Protected method	CreateInfo(DataRow, Boolean)	Creates a new info object.
Public method	CreateWebFarmTask(String, String)	Creates web farm task specific for current object and action name (Inherited from AbstractProvider.)
Public method	CreateWebFarmTask(String, String, Byte[])	Creates web farm task specific for current object and action name (Inherited from AbstractProvider.)
Protected method	DeleteData(String)	Deletes the data in the database based on the given where condition.
Protected method	DeleteData(IWhereCondition)	Deletes the data in the database based on the given where condition.
Protected method	DeleteData(Action<ObjectQuery<TInfo>>)	Deletes the data in the database based on the given where condition.
Protected method	DeleteInfo	Deletes the object to the database.
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables.
Protected method Static member	ExecuteQuery(String, QueryDataParameters, String, String, Int32, String)	Executes query and returns result as a dataset.
Public method Static member	ExecuteQuery(String, QueryDataParameters, String, String, Int32, String, Int32, Int32, Int32)	Executes query and returns result as a dataset.
Public method	GetBindingWhereCondition(String, Int32)	Gets the where condition to limit the objects to specific binding dependency. Use this method only for 2-keys bindings.
Public method	GetBindingWhereCondition(String, Object[])	Gets the where condition to limit the objects to specific binding dependencies. Use this method for 3 and more-keys bindings.
Protected method	GetCacheDependency(DataSet, String, String)	Gets the cache dependency for the given object.
Protected method	GetCacheDependency(BaseInfo, String, String)	Gets the cache dependency for the given object.
Public method Static member	GetCount	Gets the number of items matching the given condition. Does not check the license when retrieving data.
Protected method	GetCountInternal	Gets the number of items matching the given parameters. Does not check the license when retrieving data.
Protected method	GetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32)	Returns the data according to the set of input parameters.
Protected method	GetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32, Int32, Int32, Int32)	Returns the data according to the set of input parameters.
Protected method	GetDataByColumn<T>	Returns the data according to the set of input parameters.
Protected method	GetDataByGuidColumn	Returns the data according to the set of input parameters.
Protected method	GetDataByIntColumn	Returns the data according to the set of input parameters.
Protected method	GetDataByStringColumn	Returns the data according to the set of input parameters.
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters
Protected method	GetDependencyCacheKeys(DataSet, String, String)	Gets the cache dependency keys for the given DataSet.
Protected method	GetDependencyCacheKeys(GeneralizedInfo, String, String)	Gets the cache dependency keys for the given object.
Protected method	GetEmptyDataSet	Gets the empty data set to be filled by the data
Public method Static member	GetExistingIDs	Filters out all object IDs that do not exist in the database.
Protected method	GetExistingIDsInternal	Filters out all object IDs that do not exist in the database.
Protected method	GetFullNameDictionary	Creates new dictionary for caching the objects by full name
Protected method	GetFullNameWhereCondition	Gets the where condition that searches the object based on the given full name
Protected method	GetInfo(IWhereCondition)	Gets an instance of the first info object matching the specified condition.
Protected method	GetInfo(Action<ObjectQuery<TInfo>>)	Gets an instance of the first info object matching the specified condition.
Protected method	GetInfo(String, String)	Gets an instance of the first info object matching the specified condition.
Protected method	GetInfoByCodeName(String)	Gets an instance of info object based on the given code name.
Protected method	GetInfoByCodeName(String, Boolean)	Gets an instance of info object based on the given code name.
Protected method	GetInfoByCodeName(String, Int32)	Gets an instance of info object based on the given code name.
Protected method	GetInfoByCodeName(String, Int32, Boolean)	Gets an instance of info object based on the given code name.
Protected method	GetInfoByCodeName(String, Int32, Int32)	Gets an instance of info object based on the given code name.
Protected method	GetInfoByCodeName(String, Int32, Boolean, Boolean)	Gets an instance of info object based on the given code name.
Protected method	GetInfoByCodeName(String, Int32, Int32, Boolean)	Gets an instance of info object based on the given code name.
Protected method	GetInfoByCodeNameFromDB	Gets an instance of info object based on the given code name from database
Protected method	GetInfoByFullName(String)	Gets an instance of info object based on the given full name.
Protected method	GetInfoByFullName(String, Boolean)	Gets an instance of info object based on the given full name.
Protected method	GetInfoByFullNameInternal	Gets the info by its full name from the database
Protected method	GetInfoByGuid(Guid)	Gets an instance of info object based on the GUID.
Protected method	GetInfoByGuid(Guid, Boolean)	Gets an instance of info object based on the given code name.
Protected method	GetInfoByGuid(Guid, Int32)	Gets an instance of info object based on the GUID.
Protected method	GetInfoByGuid(Guid, Int32, Boolean)	Gets an instance of info object based on the GUID.
Protected method	GetInfoByGuidColumn	Gets an instance of info object based on the string column value.
Protected method	GetInfoByGuidFromDB	Gets an instance of info object based on the given GUID from database
Protected method	GetInfoById(Int32)	Gets an instance of info object based on ID.
Protected method	GetInfoById(Int32, Boolean)	Gets an instance of info object based on ID.
Protected method	GetInfoByIntColumn	Gets an instance of info object based on the integer column value.
Protected method	GetInfoByStringColumn	Gets an instance of info object based on the string column value.
Protected method	GetInfosByIds	Gets the list of info objects by their IDs
Protected method	GetObjectQuery	Gets the object query for the provider
Protected method	GetObjectQueryInternal	Gets the object query for the provider
Public method	GetParentWhereCondition	Gets the where condition to limit the objects to specific parent.
Protected method	GetSingleObject	Gets the object query for the provider
Public method	GetSiteWhereCondition(Int32)	Gets the where condition to limit the objects to specific site.
Public method	GetSiteWhereCondition(Int32, Boolean)	Gets the where condition to limit the objects to specific site.
Protected method	GetTypeInfo	Gets the type info for this provider (Inherited from BaseAbstractInfoProvider.)
Protected method Static member	CheckObject	Checks if the given info object is not null. Throws an exception if it is.
Public method	CheckUniqueCodeName	Checks if the object has unique code name. Returns true if the object has unique code name.
Public method	CheckUniqueValues	Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique.
Protected method	Init	Initializes the provider variables. (Inherited from BaseAbstractInfoProvider.)
Protected method	InitHashtables	Initializes the hashtable settings
Protected method	Invalidate	Sets this provider as invalid (Inherited from AbstractProvider.)
Protected method	LoadAllInfos	Loads all infos to the hashtable
Protected method	LoadGeneration	Loads the specified generation of the objects.
Protected method	LoadInfos	Loads all objects from the database to memory.
Protected method	LoadObjectsToHashtables	Loads the objects from a DataSet to the hashtables
Protected method Static member	NewInfo	Returns new info object.
Public method	NewTransaction	Creates a new transaction over this provider
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Inherited from BaseAbstractInfoProvider.)
Protected method	RecalculateData	Recalculates the value in the given column using the coefficient.
Public method	RefreshObjectsCounts	Updates all counts for all sub-objects. (Inherited from BaseAbstractInfoProvider.)
Protected method	Register	Registers current provider in providers collection (Inherited from AbstractProvider.)
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables.
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable
Protected method	ReplaceData	Replaces the data in the given columns.
Public method	ResetToDefault	Resets the provider to default implementation (Inherited from AbstractInfoProvider<TProvider>.)
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider (Inherited from AbstractInfoProvider<TProvider>.)
Protected method	SetInfo	Inserts or Updates the object to the database.
Public method	SortAlphabetically	Sorts the object alphabetically.
Protected method	TouchCacheDependencies	Touches the cache dependencies of the given object.
Protected method	UpdateData	Updates the data in the database based on the given where condition.
Protected method	UpdateObjectInHashtables	Updates the object instance in the hashtables. Updates is different than register, because it logs task about changing object.
Public method	UseSource(TInfo[])	Sets the provider to use given data as data source
Public method	UseSource(DataQuerySource)	Sets the provider to use given data as data source (Inherited from BaseAbstractInfoProvider.)
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid.

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	hashtableLock	Table lock for loading hashtables (Inherited from BaseAbstractInfoProvider.)
Protected field	infos	Info tables. (Inherited from BaseAbstractInfoProvider.)
Protected field	mTypeInfo	Object type information. (Inherited from BaseAbstractInfoProvider.)

Properties

	Name	Description
Protected property	DataSource	Data source for the provider (Inherited from BaseAbstractInfoProvider.)
Protected property	GenerationColumn	Obsolete. Column used to filter the data according the generation in which the items should be loaded. (Inherited from BaseAbstractInfoProvider.)
Public property	HashtableSettings	Hashtable settings (Inherited from BaseAbstractInfoProvider.)
Protected property	InfoObject	Info object instance the provider is working with.
Public property	InfoType	Returns the type of the info object for this provider (Overrides BaseAbstractInfoProvider.InfoType.)
Public property	IsDataAvailable	Returns true if the data is available for this provider (Inherited from BaseAbstractInfoProvider.)
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractProvider.)
Protected property	LoadHashtables	Obsolete. Determines the mode in which the hashtables should be loaded. In case the hashtables are loaded through generations, you must also specify the GenerationColumn property. (Inherited from BaseAbstractInfoProvider.)
Protected property	ProviderName	Provider name (Inherited from BaseAbstractInfoProvider.)
Public property	StoreEmptyValuesInHashtables	If true, provider hashtables store empty values for not found objects to reduce database calls
Public property	TypeInfo	Object type information. (Inherited from BaseAbstractInfoProvider.)
Protected property	UseFullNameHashtable	Obsolete. If true, the full name hashtable is allowed to be used. (Inherited from BaseAbstractInfoProvider.)
Protected property	UseGUIDHashtable	Obsolete. If true, the guid hashtable is allowed to be used. (Inherited from BaseAbstractInfoProvider.)
Protected property	UseHashtables	Obsolete. If true, the provider uses hashtables. (Inherited from BaseAbstractInfoProvider.)
Protected property	UseIDHashtable	Obsolete. If true, the ID hashtable is allowed to be used. (Inherited from BaseAbstractInfoProvider.)
Protected property	UseNameHashtable	Obsolete. If true, the code name hashtable is allowed to be used. (Inherited from BaseAbstractInfoProvider.)
Protected property	UseWeakReferences	Obsolete. If true, the weak references are used for the items so the memory can be cleared upon request (Inherited from BaseAbstractInfoProvider.)