Click or drag to resize
AbstractInfoProviderTInfo, TProvider, TQuery Class
Abstract info class provider.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineAbstractInfoProviderTInfo, TProvider, TQuery
    CMS.DataEngineAbstractInfoProviderTInfo, TProvider

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 13.0.131
Syntax
C#
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 AbstractInfoProviderTInfo, TProvider, TQuery type exposes the following members.

Constructors
Fields
  NameDescription
Protected fieldinfos
Info tables.
Top
Properties
  NameDescription
Public propertyDataSource
Data source for the provider
Public propertyHashtableSettings
Gets hashtable settings
Protected propertyInfoObject
Info object instance the provider is working with.
Public propertyIsValid
Indicates if the provider instance is up-to-date and can be used to manage object instances.
Public propertyStatic memberProviderObject

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 propertyTypeInfo
Object type information.
Top
Methods
  NameDescription
Protected methodBeginTransaction
Creates a new transaction over this provider.
Public methodBulkDelete
Bulk deletes info objects based on the given condition.
Public methodBulkInsertInfos(IEnumerableBaseInfo)
Bulk inserts the given list of info objects
Public methodBulkInsertInfos(IEnumerableTInfo, BulkInsertSettings)
Bulk inserts the given list of info objects.
Protected methodStatic memberCheckObject
Checks if the given info object is not null. Throws an exception if it is.
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
Public methodCheckUniqueValues
Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique.
Protected methodClearHashtables
Clears the object's hashtables.
Protected methodCreateDefaultBulkInsertSettings
Creates bulk insert settings. By default CheckConstraints and TableLock flags are set.
Protected methodCreateInfo
Creates a new info object.
Public methodCreateWebFarmTask(String, String)
Creates web farm task specific for current object and action name
Public methodCreateWebFarmTask(String, String, Byte, String)
Creates web farm task specific for current object and action name
Protected methodDeleteInfo
Deletes the object to the database.
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
Protected methodGetInfoByCodeName(String, Boolean)
Gets an instance of info object based on the given code name.
Protected methodGetInfoByCodeName(String, Int32, Boolean)
Gets an instance of info object based on the given code name.
Protected methodGetInfoByCodeName(String, Int32, Boolean, Boolean)
Gets an instance of info object based on the given code name.
Protected methodGetInfoByCodeName(String, Int32, Int32, Boolean)
Gets an instance of info object based on the given code name.
Protected methodGetInfoByCodeNameAsync(String, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given code name.
Protected methodGetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given code name.
Protected methodGetInfoByFullName
Gets an instance of info object based on the given full name.
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given GUID.
Protected methodGetInfoByGuid(Guid, Int32, Boolean)
Gets an instance of info object based on the GUID.
Protected methodGetInfoByGuidAsync(Guid, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given GUID.
Protected methodGetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the GUID.
Protected methodGetInfoById
Gets an instance of info object based on ID.
Protected methodGetInfoByIdAsync
Asynchronously gets an instance of info object based on ID.
Protected methodGetInfosByIds
Gets the list of info objects by their IDs.
Protected methodGetObjectQuery
Gets the object query for the provider
Protected methodGetObjectQueryInternal
Gets the object query for the provider
Protected methodInit
Initializes the provider with the given type info and hashtable settings
Protected methodInitHashtableSettings
Initializes the HashtableSettings based on typeInfo and using settings as default values.
Protected methodInitTypeInfoAndRegister
Initializes the provider variables.
Public methodInvalidate
Sets this provider as invalid
Protected methodLoadAllInfos
Loads all infos to the hashtable
Protected methodLoadInfos
Loads all objects from the database to memory.
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
Protected methodProcessWebFarmTaskInternal
Runs the processing of specific web farm task for current provider
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
Public methodSetAsDefaultProvider

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 methodSetInfo
Inserts or Updates the object to the database.
Protected methodUpdateData(String, QueryDataParameters, String)
Updates the data in the database based on the given where condition.
Protected methodUpdateData(IWhereCondition, IEnumerableKeyValuePairString, Object, Boolean)
Updates the data in the database based on the given where condition.
Protected methodUpdateObjectInHashtables
Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object.
Public methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
Top
See Also