AbstractInfoProvider<TInfo, TProvider, TQuery> Class

Abstract info class provider.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<TInfo, TProvider, TQuery>
    CMS.DataEngine.AbstractInfoProvider<TInfo, TProvider>

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

Syntax

public abstract class AbstractInfoProvider<TInfo, TProvider, TQuery> : IInfoProvider, 
	ICustomizableProvider, IBulkOperationProvider, IWebFarmProvider, ITestableProvider
where TInfo : new(), AbstractInfoBase<TInfo>
where TProvider : AbstractInfoProvider<TInfo, TProvider, TQuery>
where TQuery : new(), ObjectQueryBase<TQuery, TInfo>

Type Parameters

TInfo

TProvider

TQuery

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

Constructors

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

Fields

	Name	Description
Protected field	infos	Info tables.

Properties

	Name	Description
Public property	DataSource	Data source for the provider
Public property	HashtableSettings	Gets hashtable settings
Protected property	InfoObject	Info object instance the provider is working with.
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances.
Public property Static member	ProviderObject	Gets or sets the provider instance. Since the providers are managed by IoC container, setting the provider instance must be performed before the IoC container initialization finishes (i.e. during application pre-initialization).
Public property	TypeInfo	Object type information.

Methods

	Name	Description
Protected method	BeginTransaction	Creates a new transaction over this provider.
Public method	BulkDelete	Bulk deletes info objects based on the given condition.
Public method	BulkInsertInfos(IEnumerable<BaseInfo>)	Bulk inserts the given list of info objects
Public method	BulkInsertInfos(IEnumerable<TInfo>, BulkInsertSettings)	Bulk inserts the given list of info objects.
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	ClearHashtables	Clears the object's hashtables.
Protected method	CreateDefaultBulkInsertSettings	Creates bulk insert settings. By default CheckConstraints and TableLock flags are set.
Protected method	CreateInfo	Creates a new info object.
Public method	CreateWebFarmTask(String, String)	Creates web farm task specific for current object and action name
Public method	CreateWebFarmTask(String, String, Byte[], String)	Creates web farm task specific for current object and action name
Protected method	DeleteInfo	Deletes the object to the database.
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables.
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters
Protected method	GetInfoByCodeName(String, Boolean)	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, 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	GetInfoByCodeNameAsync(String, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name.
Protected method	GetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name.
Protected method	GetInfoByFullName	Gets an instance of info object based on the given full name.
Protected method	GetInfoByGuid(Guid, Boolean)	Gets an instance of info object based on the given GUID.
Protected method	GetInfoByGuid(Guid, Int32, Boolean)	Gets an instance of info object based on the GUID.
Protected method	GetInfoByGuidAsync(Guid, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given GUID.
Protected method	GetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the GUID.
Protected method	GetInfoById	Gets an instance of info object based on ID.
Protected method	GetInfoByIdAsync	Asynchronously gets an instance of info object based on ID.
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
Protected method	Init	Initializes the provider with the given type info and hashtable settings
Protected method	InitHashtableSettings	Initializes the HashtableSettings based on typeInfo and using settings as default values.
Protected method	InitTypeInfoAndRegister	Initializes the provider variables.
Public method	Invalidate	Sets this provider as invalid
Protected method	LoadAllInfos	Loads all infos to the hashtable
Protected method	LoadInfos	Loads all objects from the database to memory.
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider
Protected method	ProcessWebFarmTaskInternal	Runs the processing of specific web farm task for current provider
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables.
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider. Since the providers are managed by IoC container, setting the provider instance must be performed before the IoC container initialization finishes (i.e. during application pre-initialization).
Protected method	SetInfo	Inserts or Updates the object to the database.
Protected method	UpdateData(String, QueryDataParameters, String)	Updates the data in the database based on the given where condition.
Protected method	UpdateData(IWhereCondition, IEnumerable<KeyValuePair<String, Object>>, Boolean)	Updates the data in the database based on the given where condition.
Protected method	UpdateObjectInHashtables	Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object.
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid.