Table of Contents

Class DataClassInfoProvider

Namespace
CMS.DataEngine
Assembly
CMS.DataEngine.dll

Provides access to data class information.

public class DataClassInfoProvider : DataClassInfoProviderBase<DataClassInfoProvider>, IInfoProvider, ICustomizableProvider, IBulkOperationProvider, IWebFarmProvider, IInfoValidator<DataClassInfo>, IInfoProvider<DataClassInfo>, IInfoByIdProvider<DataClassInfo>, IInfoByGuidProvider<DataClassInfo>, IInfoByNameProvider<DataClassInfo>, IBulkInfoProvider<DataClassInfo>
Inheritance
object
DataClassInfoProvider
Implements
Inherited Members
Extension Methods

Fields

ALL_CLASSNAMES

Supplementary constant to specify all class names.

[Obsolete("Constant is deprecated and will be removed in the next version.")]
[ObsoleteSince(28, 4)]
public const string ALL_CLASSNAMES = "##ALL##"

Field Value

string

UseDataQueryForSchema

If true, the data query is used for getting the class schema from the database

[Obsolete("Property is deprecated and will be removed in the next version.")]
[ObsoleteSince(28, 4)]
public static BoolAppSetting UseDataQueryForSchema

Field Value

BoolAppSetting

ZERO_TIME

Zero time constant.

[Obsolete("Constant is deprecated and will be removed in the next version.")]
[ObsoleteSince(28, 4)]
public static DateTime ZERO_TIME

Field Value

DateTime

Methods

DeleteInfo(DataClassInfo)

Deletes the object to the database.

protected override void DeleteInfo(DataClassInfo info)

Parameters

info DataClassInfo

Object to delete

GetClassName(int)

Gets the specified DataClassName.

public static string GetClassName(int classId)

Parameters

classId int

Returns

string

GetDataClassInfo(string, bool)

Returns DataClassInfo with specified name.

public static DataClassInfo GetDataClassInfo(string name, bool throwIfNotFound)

Parameters

name string

DataClassInfo name

throwIfNotFound bool

If true, the call throws an exception in case the data class was not found

Returns

DataClassInfo

Exceptions

DataClassNotFoundException

Thrown when the data class with the given class name is not found.

GetDataSet(string)

Gets an empty DataSet created by class XML schema.

[Obsolete("Method is deprecated and will be removed in the next version.")]
[ObsoleteSince(27, 0)]
public static DataSet GetDataSet(string className)

Parameters

className string

Class name

Returns

DataSet

Exceptions

DataClassNotFoundException

Thrown when the data class with the given class name is not found.

GetObjectQueryInternal()

Gets the object query for the provider

protected override ObjectQuery<DataClassInfo> GetObjectQueryInternal()

Returns

ObjectQuery<DataClassInfo>

GetUniqueClassName(string)

Returns unique class name created from the given class name.

public static string GetUniqueClassName(string className)

Parameters

className string

Base class name

Returns

string

LoadAllClasses()

Loads all the classes into the hashtable.

[Obsolete("Method is deprecated and will be removed in the next version.")]
[ObsoleteSince(27, 0)]
public static void LoadAllClasses()

SetInfo(DataClassInfo)

Inserts or Updates the object to the database.

protected override void SetInfo(DataClassInfo info)

Parameters

info DataClassInfo

Object to insert / update

Validate(DataClassInfo)

Validates whether the info object's state satisfies domain specific constraints and returns the validation result.

public override InfoValidationResult Validate(DataClassInfo info)

Parameters

info DataClassInfo

Info object to be validated.

Returns

InfoValidationResult

Returns validation result with IsValid set to true, if info is valid. Otherwise returns result with the flag set to false and a corresponding error message.

Remarks

Implement IInfoValidator<TInfo> and register it into the system to perform domain specific validation for DataClassInfo. The system invokes the registered validators as part of validation performed by this method.

The default implementation validates the code name to contain only allowed characters and to be unique.

Exceptions

ArgumentNullException

Thrown when info is null.

See Also

ValidateShortCodeName(DataClassInfo)

Validates the object short code name. Returns true if the short code name is valid.

protected bool ValidateShortCodeName(DataClassInfo info)

Parameters

info DataClassInfo

Object to check

Returns

bool