Click or drag to resize
DataClassInfoProvider Class
Provides access to data class information.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineAbstractInfoProviderDataClassInfo, DataClassInfoProvider, ObjectQueryDataClassInfo
    CMS.DataEngineAbstractInfoProviderDataClassInfo, DataClassInfoProvider
      CMS.DataEngineDataClassInfoProviderBaseDataClassInfoProvider
        CMS.DataEngineDataClassInfoProvider

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 13.0.131
Syntax
C#
public class DataClassInfoProvider : DataClassInfoProviderBase<DataClassInfoProvider>

The DataClassInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodDataClassInfoProvider
Top
Fields
  NameDescription
Public fieldStatic memberALL_CLASSNAMES
Supplementary constant to specify all class names.
Protected fieldinfos
Info tables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public fieldStatic memberUseDataQueryForSchema
If true, the data query is used for getting the class schema from the database
Public fieldStatic memberZERO_TIME
Zero time constant.
Top
Properties
  NameDescription
Public propertyDataSource
Data source for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyStatic memberFormLayoutsDirectory
Form layouts directory - Read only
Public propertyHashtableSettings
Gets hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected propertyInfoObject
Info object instance the provider is working with.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyIsValid
Indicates if the provider instance is up-to-date and can be used to manage object instances.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyStatic memberStoreFormLayoutsInExternalStorage
Gets or sets the value that indicates whether class layouts should be stored externally
Public propertyTypeInfo
Object type information.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
Methods
  NameDescription
Protected methodBeginTransaction
Creates a new transaction over this provider.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkDelete
Bulk deletes info objects based on the given condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableBaseInfo)
Bulk inserts the given list of info objects
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableTInfo, BulkInsertSettings)
Bulk inserts the given list of info objects.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberCheckDatabaseDependencies
Checks if some database objects are dependent on database representation of this class.
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodClearHashtables
Clears the object's hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateDefaultBulkInsertSettings
Creates bulk insert settings. By default CheckConstraints and TableLock flags are set.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateInfo
Creates a new info object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String, Byte, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodDelete
Deletes the info object from the underlying data store.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodDeleteInfo
Deletes the object to the database.
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryDeleteInfo(TInfo).)
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(Inherited from DataClassInfoProviderBaseTProvider.)
Public methodGet
Gets the object query for TInfo retrieval.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Guid)
Gets an instance of info object based on its GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Int32)
Gets an instance of info object based on its ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(String)
Gets an instance of info object based on its code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Guid, Int32)
Gets an instance of info object based on its GUID and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(String, Int32)
Gets an instance of info object based on its code name and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Guid, NullableCancellationToken)
Asynchronously gets an instance of info object based on its GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(String, NullableCancellationToken)
Asynchronously gets an instance of info object based on its code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Guid, Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its GUID and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(String, Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its code name and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberGetClassName
Gets the specified DataClassName.
Public methodStatic memberGetDataClassInfo
Returns DataClassInfo with specified name.
Public methodStatic memberGetDataSet
Gets an empty DataSet created by class XML schema.
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeNameAsync(String, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByFullName
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Int32, Boolean)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuidAsync(Guid, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoById
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByIdAsync
Asynchronously gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfosByIds
Gets the list of info objects by their IDs.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetObjectQuery
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetObjectQueryInternal
Gets the object query for the provider
(Overrides AbstractInfoProviderTInfo, TProviderGetObjectQueryInternal.)
Public methodStatic memberGetUniqueClassName
Returns unique class name created from the given class name.
Public methodStatic memberGetVirtualObject
Returns DataClassInfo object for specified path.
Protected methodInit
Initializes the provider with the given type info and hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitHashtableSettings
Initializes the HashtableSettings based on typeInfo and using settings as default values.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitTypeInfoAndRegister
Initializes the provider variables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodInvalidate
Sets this provider as invalid
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberLoadAllClasses
Loads all the classes into the hashtable.
Protected methodLoadAllInfos
Loads all infos to the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodProcessWebFarmTaskInternal
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodSet
Inserts or updates the info object in the underlying data store.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
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).

(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodSetInfo
Inserts or Updates the object to the database.
(Overrides DataClassInfoProviderBaseTProviderSetInfo(DataClassInfo).)
Protected methodUpdateData(String, QueryDataParameters, String)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateData(IWhereCondition, IEnumerableKeyValuePairString, Object, Boolean)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateObjectInHashtables
Updates the object instance in the hashtables. Updates is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object.
(Inherited from DataClassInfoProviderBaseTProvider.)
Public methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
See Also