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: 8.2.23

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.

Methods

	Name	Description
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.
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[])	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
Public method Static member	GetId	Gets the ID by the given code name
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	Init	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	Sets the provider to use given data as data source

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
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
Protected field	mTypeInfo	Object type information.
Public field Static member	UNKNOWN_TYPEINFO	Type information.

Properties

	Name	Description
Protected property	DataSource	Data source for the provider
Protected property	GenerationColumn	Obsolete. Column used to filter the data according the generation in which the items should be loaded.
Public property	HashtableSettings	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	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.
Protected property	ProviderName	Provider name (Overrides AbstractProvider.ProviderName.)
Public property	TypeInfo	Object type information.
Protected property	UseFullNameHashtable	Obsolete. If true, the full name hashtable is allowed to be used.
Protected property	UseGUIDHashtable	Obsolete. If true, the guid hashtable is allowed to be used.
Protected property	UseHashtables	Obsolete. If true, the provider uses hashtables.
Protected property	UseIDHashtable	Obsolete. If true, the ID hashtable is allowed to be used.
Protected property	UseNameHashtable	Obsolete. If true, the code name hashtable is allowed to be used.
Protected property	UseWeakReferences	Obsolete. If true, the weak references are used for the items so the memory can be cleared upon request