SaaS CMS has officially launched! Learn more now.

Class HistoryManager

Represents history module.

Inheritance
System.Object
HistoryManager
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Mediachase.BusinessFoundation.Data.Modules
Assembly: Mediachase.BusinessFoundation.Data.dll
Version: 11.8.3
Syntax
public static class HistoryManager

Fields

HistoryClassPostfix

Declaration
public const string HistoryClassPostfix = "_History"
Field Value
Type Description
System.String

HistoryTriggerContainerName

Declaration
public const string HistoryTriggerContainerName = "HistoryTrigger"
Field Value
Type Description
System.String

ModuleFriendlyName

Declaration
public const string ModuleFriendlyName = "McHistory"
Field Value
Type Description
System.String

ModuleName

Declaration
public const string ModuleName = "McHistory"
Field Value
Type Description
System.String

ObjectReferenceFieldName

Declaration
public const string ObjectReferenceFieldName = "ObjectId"
Field Value
Type Description
System.String

SelectedFieldsPropertyName

Declaration
public const string SelectedFieldsPropertyName = "SelectedFields"
Field Value
Type Description
System.String

Methods

CreateModuleManifest()

Creates the module manifest.

Declaration
public static ModuleManifest CreateModuleManifest()
Returns
Type Description
ModuleManifest

GetHistoryMetaClass(MetaClass)

Gets the history meta class.

Declaration
public static MetaClass GetHistoryMetaClass(MetaClass metaClass)
Parameters
Type Name Description
MetaClass metaClass

The meta class.

Returns
Type Description
MetaClass

GetHistoryMetaClassName(String)

Gets the name of the history meta class.

Declaration
public static string GetHistoryMetaClassName(string metaClassName)
Parameters
Type Name Description
System.String metaClassName

Name of the meta class.

Returns
Type Description
System.String

GetOriginalMetaClass(MetaClass)

Gets the history meta class.

Declaration
public static MetaClass GetOriginalMetaClass(MetaClass metaClass)
Parameters
Type Name Description
MetaClass metaClass

The meta class.

Returns
Type Description
MetaClass

GetOriginalMetaClassName(String)

Gets the name of the history meta class.

Declaration
public static string GetOriginalMetaClassName(string metaClassName)
Parameters
Type Name Description
System.String metaClassName

Name of the meta class.

Returns
Type Description
System.String

GetSelectedFields(MetaClass)

Gets the selected fields.

Declaration
public static string[] GetSelectedFields(MetaClass metaClass)
Parameters
Type Name Description
MetaClass metaClass

The meta class.

Returns
Type Description
System.String[]

GetSelectedFields(String)

Gets the selected fields.

Declaration
public static string[] GetSelectedFields(string metaClassName)
Parameters
Type Name Description
System.String metaClassName

Name of the meta class.

Returns
Type Description
System.String[]

IsSupportedField(MetaField)

Supports the history.

Declaration
public static bool IsSupportedField(MetaField srcMetaField)
Parameters
Type Name Description
MetaField srcMetaField

The SRC meta field.

Returns
Type Description
System.Boolean

IsSupportedField(String, String)

Determines whether [is supported field] [the specified meta class name].

Declaration
public static bool IsSupportedField(string metaClassName, string metaFieldName)
Parameters
Type Name Description
System.String metaClassName

Name of the meta class.

System.String metaFieldName

Name of the meta field.

Returns
Type Description
System.Boolean

true if [is supported field] [the specified meta class name]; otherwise, false.

MetaClassIsHistory(MetaClass)

Metas the class is history.

Declaration
public static bool MetaClassIsHistory(MetaClass metaClass)
Parameters
Type Name Description
MetaClass metaClass

The meta class.

Returns
Type Description
System.Boolean

MetaClassIsHistory(String)

Metas the class is history.

Declaration
public static bool MetaClassIsHistory(string metaClassName)
Parameters
Type Name Description
System.String metaClassName

Name of the meta class.

Returns
Type Description
System.Boolean

SetSelectedFields(MetaClass, String[])

Sets the selected fields.

Declaration
public static void SetSelectedFields(MetaClass metaClass, params string[] selectedFieldNames)
Parameters
Type Name Description
MetaClass metaClass

The meta class.

System.String[] selectedFieldNames

The selected field names.

SetSelectedFields(String, String[])

Sets the selected fields.

Declaration
public static void SetSelectedFields(string metaClassName, params string[] selectedFieldNames)
Parameters
Type Name Description
System.String metaClassName

Name of the meta class.

System.String[] selectedFieldNames

The selected field names.