BaseAbstractInfoProvider Class

Base class for the info providers.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractProvider
    CMS.DataEngine.BaseAbstractInfoProvider
      CMS.DataEngine.AbstractInfoProvider<TProvider>

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

Syntax

public abstract class BaseAbstractInfoProvider : AbstractProvider

The BaseAbstractInfoProvider type exposes the following members.

Constructors

	Name	Description
Protected method	BaseAbstractInfoProvider()	Default constructor.
Protected method	BaseAbstractInfoProvider(ObjectTypeInfo)	Constructor.

Fields

	Name	Description
Public field Static member	ALL_SITES	All sites constant for the data retrieval.
Protected field	hashtableLock	Table lock for loading hashtables
Protected field	infos	Info tables.
Public field Static member	INVALIDATE_COLUMN_NAMES	Codename for column names invalidation
Public field Static member	UNKNOWN_TYPEINFO	Obsolete. Type information.

Properties

	Name	Description
Protected property	DataSource	Data source for the provider
Public property	HashtableSettings	Gets hashtable settings
Public property	InfoType	Returns the type of the info object for this provider
Public property	IsDataAvailable	Returns true if the data is available for this provider
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	ProviderName	Provider name (Overrides AbstractProvider.ProviderName.)
Public property	TypeInfo	Object type information.

Methods

	Name	Description
Protected method	ApplySource<TQuery>	If the provider has a data source specified, applies this source to the given query. Returns the modified query.
Protected method	BoundGetInfoByFullName	Gets the info by full name
Protected method	BoundGetInfoByGuid(Guid)	Gets the info by GUID
Protected method	BoundGetInfoByGuid(Guid, Int32)	Gets the info by GUID
Protected method	BoundGetInfoById	Gets the info by ID.
Protected method	BoundGetInfoByName(String)	Gets the info by code name
Protected method	BoundGetInfoByName(String, Int32)	Gets the info by code name
Protected method	BoundGetInfosByIds	Gets the info by its type and ID from the appropriate provider.
Public method	BulkInsertInfos	Bulk inserts the given list of info objects
Protected method	ClearHashtables(Boolean)	Clears the object's hashtables. (Inherited from AbstractProvider.)
Protected method	CreateHashtables	Creates the provider hashtables
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[], String)	Creates web farm task specific for current object and action name (Inherited from AbstractProvider.)
Public method Static member	GetCodeName	Gets the code name by the given ID
Protected method	GetCurrentProvider	Gets the current provider instance (Inherited from AbstractProvider.)
Protected method	GetFullNameWhereCondition	Gets the where condition that searches the object based on the given full name.
Protected method	GetGeneralObjectQuery	Gets an object query from the provider
Public method Static member	GetId	Gets the ID by the given code name
Public method Static member	GetInfoByFullName	Gets the info by its type and full name from the appropriate provider.
Public method Static member	GetInfoByGuid(String, Guid, Boolean)	Gets the info by its type and GUID from the appropriate provider.
Public method Static member	GetInfoByGuid(String, Guid, Int32, Boolean)	Gets the info by its type and GUID from the appropriate provider.
Public method Static member	GetInfoById	Gets the info by its type and ID from the appropriate provider.
Public method Static member	GetInfoByName(String, String, Boolean)	Gets the info by its type and code name from the appropriate provider.
Public method Static member	GetInfoByName(String, String, Int32, Boolean)	Gets the info by its type and code name from the appropriate provider.
Public method Static member	GetInfoProvider	Gets the loaded provider by its object type.
Public method Static member	GetInfosByIds	Gets the info by its type and ID from the appropriate provider.
Protected method	GetTypeInfo	Gets the type info for this provider
Protected method	InitHashtableSettings	Initializes the HashtableSettings based on typeInfo and using settings as default values.
Protected method	InitTypeInfoAndRegister	Initializes the provider variables.
Protected method	Invalidate	Sets this provider as invalid (Inherited from AbstractProvider.)
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Overrides AbstractProvider.ProcessWebFarmTask(String, String, Byte[]).)
Public method	RefreshObjectsCounts	Updates all counts for all sub-objects.
Protected method	Register	Registers current provider in providers collection (Inherited from AbstractProvider.)
Public method	ResetToDefault	Resets the provider to default implementation
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider (Inherited from AbstractProvider.)
Public method	UseSource	Obsolete. Sets the provider to use given data as data source