Class EntitySchema

Represents the schema of an object.

Inheritance
System.Object
MetaItem
MetaSchema
Schema
ProcessBasedSchema
EntitySchema
SysBaseEntitySchema
SysEmptySchema
SysOneRecordSchema
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: Terrasoft.Core.Entities
Assembly: Terrasoft.Core.dll
Syntax
[MetaType("{2E75BAEF-633F-498c-8A89-0F2D9DB4D568}")]
[DesignModeClass(ResourceManager = "Terrasoft.Core", OverrideResources = true)]
[IsVirtual]
[DesignModeGroup(Name = "General", Position = 1)]
[DesignModeGroup(Name = "Inheritance", Position = 2)]
[DesignModeGroup(Name = "Behaviour", Position = 3)]
[DesignModeGroup(Name = "Administration", Position = 4)]
[DesignModeGroup(Name = "SystemColumns", Position = 5)]
[DesignModeGroup(Name = "HistoricalColumns", Position = 6)]
[DesignModeProperty(Name = "Caption", Group = "General", OverrideResources = true, Position = 10, UsageType = DesignModeUsageType.General, AllowEditInherited = true, ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
[DesignModeProperty(Name = "Name", OverrideResources = true, Group = "General", Position = 20, UsageType = DesignModeUsageType.General, IsRequired = true, AllowEditInherited = true)]
[DesignModeProperty(Name = "TrackChangesSchemaName", OverrideResources = true, Group = "General", Position = 25, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D29")]
[DesignModeProperty(Name = "RightSchemaName", OverrideResources = true, Group = "General", Position = 27, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D30")]
[DesignModeProperty(Name = "DesignLocalizationSchemaName", OverrideResources = true, Group = "General", Position = 28, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D31")]
[DesignModeProperty(Name = "Description", Group = "General", Position = 30, UsageType = DesignModeUsageType.Advanced, AllowEditInherited = true, ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
[DesignModeProperty(Name = "ParentSchemaUId", Group = "Inheritance", Position = 40, UsageType = DesignModeUsageType.General, AllowEditInherited = true, ValuesProvider = "EntitySchemaManagerExceptedUIdValuesProvider", MetaPropertyName = "D8")]
[DesignModeProperty(Name = "ExtendParent", Group = "Inheritance")]
[DesignModeProperty(Name = "IsDBView", Group = "Behaviour", Position = 65, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D10", AllowEditInherited = true)]
[DesignModeProperty(Name = "IsVirtual", Group = "Behaviour", Position = 70, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D1", AllowEditInherited = true)]
[DesignModeProperty(Name = "AdministratedByOperations", Group = "Administration", Position = 80, UsageType = DesignModeUsageType.General, MetaPropertyName = "D15", AllowEditInherited = true, ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
[DesignModeProperty(Name = "AdministratedByColumns", Group = "Administration", Position = 90, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D16", AllowEditInherited = true, ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
[DesignModeProperty(Name = "AdministratedByRecords", Group = "Administration", Position = 100, UsageType = DesignModeUsageType.General, MetaPropertyName = "D17", AllowEditInherited = true, ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
[DesignModeProperty(Name = "UseDenyRecordRights", Group = "Administration", Position = 240, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D26", AllowEditInherited = true)]
[DesignModeProperty(Name = "PrimaryColumn", IsRequired = true, ValuesProvider = "EntitySchemaPrimaryColumnProvider", Group = "SystemColumns", Position = 110, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D3")]
[DesignModeProperty(Name = "PrimaryDisplayColumn", ValuesProvider = "EntitySchemaPrimaryDisplayColumnProvider", Group = "SystemColumns", Position = 120, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D4", AllowEditInherited = true, ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
[DesignModeProperty(Name = "PrimaryImageColumn", ValuesProvider = "EntitySchemaPrimaryImageColumnProvider", Group = "SystemColumns", Position = 130, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D5", AllowEditInherited = true, ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
[DesignModeProperty(Name = "PrimaryColorColumn", ValuesProvider = "EntitySchemaPrimaryColorColumnProvider", Group = "SystemColumns", Position = 131, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D37", AllowEditInherited = true, ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
[DesignModeProperty(Name = "PrimaryOrderColumn", ValuesProvider = "EntitySchemaPrimaryOrderColumnProvider", Group = "SystemColumns", Position = 140, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D28", AllowEditInherited = true)]
[DesignModeProperty(Name = "HierarchyColumn", ValuesProvider = "EntitySchemaHierarchyColumnProvider", Group = "SystemColumns", Position = 150, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D7", ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
[DesignModeProperty(Name = "OwnerColumn", ValuesProvider = "EntitySchemaLookupColumnProvider", Group = "SystemColumns", Position = 160, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D21", ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
[DesignModeProperty(Name = "CreatedByColumn", ValuesProvider = "EntitySchemaLookupColumnProvider", Group = "HistoricalColumns", Position = 180, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D12")]
[DesignModeProperty(Name = "CreatedOnColumn", ValuesProvider = "EntitySchemaDateTimeColumnProvider", Group = "HistoricalColumns", Position = 190, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D11")]
[DesignModeProperty(Name = "ModifiedByColumn", ValuesProvider = "EntitySchemaLookupColumnProvider", Group = "HistoricalColumns", Position = 200, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D14")]
[DesignModeProperty(Name = "ModifiedOnColumn", ValuesProvider = "EntitySchemaDateTimeColumnProvider", Group = "HistoricalColumns", Position = 210, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D13")]
[DesignModeProperty(Name = "Columns", UsageType = DesignModeUsageType.None, MetaPropertyName = "D2", ForeignPackageEditMode = ForeignPackageEditMode.ItemsAdd)]
[DesignModeProperty(Name = "Indexes", UsageType = DesignModeUsageType.None, MetaPropertyName = "D6", ForeignPackageEditMode = ForeignPackageEditMode.ItemsAdd)]
[DesignModeProperty(Name = "Events", UsageType = DesignModeUsageType.None, MetaPropertyName = "D20", Group = "General", Position = 1000, ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
[DesignModeProperty(Name = "IsTrackChangesInDB", Group = "Behaviour", Position = 220, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D24", AllowEditInherited = true, ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
[DesignModeProperty(Name = "UseRecordDeactivation", Group = "Behaviour", Position = 230, UsageType = DesignModeUsageType.General, MetaPropertyName = "D32", AllowEditInherited = true, ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
[DesignModeProperty(Name = "MasterRecordColumn", ValuesProvider = "EntitySchemaLookupColumnProvider", Group = "Administration", Position = 250, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D22", ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
[DesignModeProperty(Name = "IsSSPAvailable", Group = "Behaviour", Position = 240, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D33", ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
[DesignModeProperty(Name = "UseLiveEditing", Group = "Behaviour", Position = 250, UsageType = DesignModeUsageType.Advanced, MetaPropertyName = "D38", ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
[DesignModeProperty(Name = "OwnerAdminUnitColumn", UsageType = DesignModeUsageType.None, MetaPropertyName = "D34", ForeignPackageEditMode = ForeignPackageEditMode.ItemsAdd)]
[DesignModeProperty(Name = "SegmentationOptions", UsageType = DesignModeUsageType.None, Group = "Behaviour", MetaPropertyName = "D35", ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
[DesignModeProperty(Name = "ShowInAdvancedModeSet", UsageType = DesignModeUsageType.None, Group = "Behaviour", MetaPropertyName = "D36", ForeignPackageEditMode = ForeignPackageEditMode.Edit)]
public class EntitySchema : ProcessBasedSchema, IMetaDataSerializable, ICloneable, IMetaSchema, IMetaItem, IManagerItemInstance, ISchemaManagerSchema<EntitySchema>

Constructors

EntitySchema(EntitySchema)

Initializes a new EntitySchema instance that is a deep clone of the given source schema.

Declaration
public EntitySchema(EntitySchema source)
Parameters
Type Name Description
EntitySchema source

Schema, which clone is created.

EntitySchema(EntitySchema, Boolean)

Initializes a new EntitySchema instance that is either a deep or shallow clone of the specified source schema depending on the isShallowClone value.

Declaration
public EntitySchema(EntitySchema source, bool isShallowClone)
Parameters
Type Name Description
EntitySchema source

Schema, which clone is created.
System.Boolean isShallowClone

Indication of completeness of schema cloning. If isShallowClone is true, the source schema columns will not be copied to the EntitySchema instance that is being created. If isShallowClone is false, the deep clone of source is created.

EntitySchema(EntitySchemaManager)

Initializes a new EntitySchema instance with the specified schema manager.

Declaration
public EntitySchema(EntitySchemaManager entitySchemaManager)
Parameters
Type Name Description
EntitySchemaManager entitySchemaManager

Schema manager.

Properties

AdministratedByColumns

Indicates that the schema is managed by columns.

Declaration
[MetaTypeProperty("{43FF0622-7255-43C7-A175-5491A56A998F}", IsExtraProperty = true)]
public bool AdministratedByColumns { get; set; }
Property Value
Type Description
System.Boolean

AdministratedByOperations

Indicates that the schema is managed by operations.

Declaration
[MetaTypeProperty("{E897E7E7-6D35-4820-AD76-9D6B8EEDF1EC}", IsExtraProperty = true)]
public bool AdministratedByOperations { get; set; }
Property Value
Type Description
System.Boolean

AdministratedByRecords

Indicates that the schema is managed by records.

Declaration
[MetaTypeProperty("{FC321306-6F9E-4493-895D-81E92FB0A0FF}", IsExtraProperty = true)]
public bool AdministratedByRecords { get; set; }
Property Value
Type Description
System.Boolean

AdministratedByRecordsIncludeParents

Declaration
public bool AdministratedByRecordsIncludeParents { get; }
Property Value
Type Description
System.Boolean

AutoInitializeColumns

Indication of automatic initialization of columns.

Declaration
public bool AutoInitializeColumns { get; set; }
Property Value
Type Description
System.Boolean

BaseSchemaUId

Base schema unique identifier.

Declaration
public static Guid BaseSchemaUId { get; }
Property Value
Type Description
System.Guid

Columns

Collection of schema columns.

Declaration
[MetaTypeProperty("{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumnCollection Columns { get; }
Property Value
Type Description
EntitySchemaColumnCollection

CreatedByColumn

Column for storing reference to contact that created the record.

Declaration
[MetaTypeProperty("{5FD383BA-C0EF-42E5-AAF2-21340CBF1736}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn CreatedByColumn { get; set; }
Property Value
Type Description
EntitySchemaColumn

CreatedOnColumn

Column for storing the record creation date.

Declaration
[MetaTypeProperty("{BF96BE34-BF05-4FAC-92AC-E51013FCC905}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn CreatedOnColumn { get; set; }
Property Value
Type Description
EntitySchemaColumn

DataValueTypeManager

Data type manager for schema columns.

Declaration
public DataValueTypeManager DataValueTypeManager { get; }
Property Value
Type Description
DataValueTypeManager

DBInheritanceType

Type of inheritance at the database level.

Declaration
[Obsolete("7.12.0 | Property is not in use and will be removed in upcoming builds")]
public EntitySchemaDBInheritanceType DBInheritanceType { get; set; }
Property Value
Type Description
EntitySchemaDBInheritanceType

DeleteOneToOneParentRecord

Indication of deleting record from the parent schema when deleting the current record in one-to-one inheritance.

Declaration
[Obsolete("7.12.0 | Property is not in use and will be removed in upcoming builds")]
public bool DeleteOneToOneParentRecord { get; set; }
Property Value
Type Description
System.Boolean

DesignLocalizationSchemaName

Localization schema name in design time.

Declaration
[MetaTypeProperty("{B59E5D74-9ECE-4762-B5AB-719F0296E79D}")]
public string DesignLocalizationSchemaName { get; set; }
Property Value
Type Description
System.String

EntitySchemaManager

Entity schema manager.

Declaration
public EntitySchemaManager EntitySchemaManager { get; }
Property Value
Type Description
EntitySchemaManager

Events

Schema events.

Declaration
public EntitySchemaEvents Events { get; set; }
Property Value
Type Description
EntitySchemaEvents

HasEvents

Indication of events for the given schema.

Declaration
public bool HasEvents { get; }
Property Value
Type Description
System.Boolean

HasIndependentProcessListeners

Indicates that the schema has its own finished conditions for the process items that differ from the system conditions.

Declaration
[MetaTypeProperty("{2210C239-82AC-468F-91C2-5E154807112D}", DefValue = false)]
public bool HasIndependentProcessListeners { get; set; }
Property Value
Type Description
System.Boolean

HierarchyColumn

Column of the parent record relationship for hierarchical entities. Used to create hierarchical queries.

Declaration
[MetaTypeProperty("{E1453316-7782-4879-84FE-F5A52BF1B575}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn HierarchyColumn { get; set; }
Property Value
Type Description
EntitySchemaColumn

Indexes

Collection of schema indexes.

Declaration
[MetaTypeProperty("{B3318A2E-51CB-44b2-B69F-7C67EA7E1BD4}")]
public EntitySchemaIndexCollection Indexes { get; }
Property Value
Type Description
EntitySchemaIndexCollection

IsDBView

Indicates whether the schema is a view in the database.

Declaration
[MetaTypeProperty("{CA155F3F-FCEB-4989-8155-8E987238734C}")]
public bool IsDBView { get; set; }
Property Value
Type Description
System.Boolean

IsDynamicallyCreated

Indicates that the schema is dynamically created.

Declaration
public bool IsDynamicallyCreated { get; set; }
Property Value
Type Description
System.Boolean

IsLocalizable

Indicates whether schema is localizable.

Declaration
public bool IsLocalizable { get; }
Property Value
Type Description
System.Boolean

IsSSPAvailable

When this property is set, this Entity can be used on SSP portal as section,

Declaration
[MetaTypeProperty("{2179DF58-CC3E-4AC8-BDF9-B75523299D5B}", IsExtraProperty = true, DefValue = false)]
public bool IsSSPAvailable { get; set; }
Property Value
Type Description
System.Boolean

IsTrackChangesInDB

Indication whether the schema is logged or not.

Declaration
[MetaTypeProperty("{D3FA0A53-F081-43E1-B394-2700B46AF89B}", DefValue = false, IsExtraProperty = true)]
public bool IsTrackChangesInDB { get; set; }
Property Value
Type Description
System.Boolean

IsVirtual

Indication of the virtual schema.

Declaration
[MetaTypeProperty("{E922C759-381C-4679-A9D9-48A95AEBDF34}", IsExtraProperty = true)]
public bool IsVirtual { get; set; }
Property Value
Type Description
System.Boolean

Kind

Schema type.

Declaration
[DBMetaTypeProperty(DBMetaInfoItemType.Schema)]
public EntitySchemaKind Kind { get; set; }
Property Value
Type Description
EntitySchemaKind

LocalizationSchemaName

Localization schema name.

Declaration
public string LocalizationSchemaName { get; }
Property Value
Type Description
System.String

Manager

Schema manager.

Declaration
public override IManager Manager { get; }
Property Value
Type Description
IManager
Overrides

MasterRecordColumn

Master record entity column. When it set, and current entity is not administrated by records, then record rights from master record will be applied. When entity is administrated by master record rights, empty master record column considered as empty rights. When entity is administrated by records and by master records, the master record rights not applied. Only lookup columns can be used for this property, required on application level preferably.

Declaration
[MetaTypeProperty("{7C25B6D3-2B8D-4E30-A14D-2EA06077CC7D}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn MasterRecordColumn { get; set; }
Property Value
Type Description
EntitySchemaColumn

MasterRecordSchemaName

Master record entity schema name.

Declaration
[MetaTypeProperty("{387020A0-AC03-42A1-ACFA-2C19DBE4D437}", IsExtraProperty = true)]
public string MasterRecordSchemaName { get; }
Property Value
Type Description
System.String

ModifiedByColumn

Column for storing reference to contact that modified the record.

Declaration
[MetaTypeProperty("{039F18C9-9A3C-4532-91CD-599C52720A8B}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn ModifiedByColumn { get; set; }
Property Value
Type Description
EntitySchemaColumn

ModifiedOnColumn

Column for storing the record modified date.

Declaration
[MetaTypeProperty("{35EF0216-88CE-41D8-A4BC-9FDF9F8B34A1}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn ModifiedOnColumn { get; set; }
Property Value
Type Description
EntitySchemaColumn

OneToOneParentAssociationColumn

Parent relationship column in the one-to-one inheritance.

Declaration
[Obsolete("7.12.0 | Property is not in use and will be removed in upcoming builds")]
public EntitySchemaColumn OneToOneParentAssociationColumn { get; set; }
Property Value
Type Description
EntitySchemaColumn

OwnerAdminUnitColumn

Gets or sets owner admin unit column.

Declaration
[MetaTypeProperty("{FF7A5266-324F-4EEB-8111-88D116F23066}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn OwnerAdminUnitColumn { get; set; }
Property Value
Type Description
EntitySchemaColumn

OwnerColumn

Column indicating an owner. Used to assign write access rights to owner.

Declaration
[MetaTypeProperty("{CFF235A3-A968-46B3-A642-CB942C67E891}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn OwnerColumn { get; set; }
Property Value
Type Description
EntitySchemaColumn

ParentSchema

Parent schema.

Declaration
public EntitySchema ParentSchema { get; set; }
Property Value
Type Description
EntitySchema

ParentSchemaUId

Unique identifier of the parent schema.

Declaration
[DBMetaTypeProperty(DBMetaInfoItemType.Schema, typeof(GuidDBMetaTypeConverter))]
public Guid ParentSchemaUId { get; set; }
Property Value
Type Description
System.Guid

PrimaryColorColumn

Declaration
[MetaTypeProperty("{17FCCA00-F226-4083-A4C8-38682452D385}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn PrimaryColorColumn { get; set; }
Property Value
Type Description
EntitySchemaColumn

PrimaryColumn

Column that represents the primary key.

Declaration
[MetaTypeProperty("{A71B72FE-76FA-4047-BD46-87121A70B188}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn PrimaryColumn { get; set; }
Property Value
Type Description
EntitySchemaColumn

PrimaryDisplayColumn

Primary data display column.

Declaration
[MetaTypeProperty("{068A7874-3656-497b-B9B5-7C489A87FF9C}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn PrimaryDisplayColumn { get; set; }
Property Value
Type Description
EntitySchemaColumn

PrimaryImageColumn

Primary image display column.

Declaration
[MetaTypeProperty("{6FD012E3-64EA-4ba0-BA59-91D0F5E7B2AA}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn PrimaryImageColumn { get; set; }
Property Value
Type Description
EntitySchemaColumn

PrimaryOrderColumn

Primary sorting column.

Declaration
[MetaTypeProperty("{7277CDFA-81D8-42B0-AE1C-5F258E93D7DB}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn PrimaryOrderColumn { get; set; }
Property Value
Type Description
EntitySchemaColumn

ProcessSchemaManager

Process schema manager.

Declaration
public override ProcessSchemaManager ProcessSchemaManager { get; }
Property Value
Type Description
ProcessSchemaManager
Overrides

RightSchemaName

Declaration
[MetaTypeProperty("{29922532-79B9-4424-947F-3598A6038A03}")]
public virtual string RightSchemaName { get; set; }
Property Value
Type Description
System.String

SegmentationOptions

Entity schema segmentation options.

Declaration
[MetaTypeProperty("{83B55A6E-7F6E-475B-892D-CEA361FDD175}")]
public EntitySchemaSegmentationOptions SegmentationOptions { get; set; }
Property Value
Type Description
EntitySchemaSegmentationOptions

ShowInAdvancedMode

Indicates whether schema is available in advanced mode in runtime.

Declaration
public bool ShowInAdvancedMode { get; set; }
Property Value
Type Description
System.Boolean

ShowInAdvancedModeDesignerValue

Indicates whether schema is available in advanced mode in design time.

Declaration
public bool ShowInAdvancedModeDesignerValue { get; set; }
Property Value
Type Description
System.Boolean

ShowInAdvancedModeSet

Entity schema segmentation options.

Declaration
[MetaTypeProperty("{3C8FDC05-6783-439B-90D7-9AA18D28FE3A}")]
public ShowInAdvancedModeSet ShowInAdvancedModeSet { get; set; }
Property Value
Type Description
ShowInAdvancedModeSet

SystemEntitySchemaManager

Manager of system entity schemas.

Declaration
public SystemEntitySchemaManager SystemEntitySchemaManager { get; }
Property Value
Type Description
SystemEntitySchemaManager

SystemNameAdditionalLength

Declaration
public static int SystemNameAdditionalLength { get; }
Property Value
Type Description
System.Int32

SystemValueManager

System input manager.

Declaration
public SystemValueManager SystemValueManager { get; }
Property Value
Type Description
SystemValueManager

TrackChangesInDBEntitySchema

Declaration
public EntitySchema TrackChangesInDBEntitySchema { get; set; }
Property Value
Type Description
EntitySchema

TrackChangesSchemaName

Declaration
[MetaTypeProperty("{7FA86DEA-D3CB-49BE-B262-19F83C06B248}")]
public virtual string TrackChangesSchemaName { get; set; }
Property Value
Type Description
System.String

UId

Unique identifier.

Declaration
[DBMetaTypeProperty(DBMetaInfoItemType.Schema, typeof(GuidDBMetaTypeConverter))]
public override Guid UId { get; set; }
Property Value
Type Description
System.Guid
Overrides

UseDenyRecordRights

Indicates that the denied access rights are used for the schema.

Declaration
[MetaTypeProperty("{E112AEFA-7D99-45FA-8621-0F26B3B85450}", DefValue = false)]
public bool UseDenyRecordRights { get; set; }
Property Value
Type Description
System.Boolean

UseLiveEditing

Use this entity for client-side notification on insert/update/delete events,

Declaration
[MetaTypeProperty("{E277E0A6-7F67-4902-838A-00DCF0B381F8}", IsExtraProperty = true, DefValue = false)]
public bool UseLiveEditing { get; set; }
Property Value
Type Description
System.Boolean

UseMasterRecordRights

Flag that indicates whether current entity uses master record rights.

Declaration
public bool UseMasterRecordRights { get; }
Property Value
Type Description
System.Boolean

UseRecordDeactivation

Indicates whether schema should use disabling records.

Declaration
[MetaTypeProperty("{187EA8EC-49F3-49ED-BFB3-4DD9ED4565BC}", DefValue = false)]
public bool UseRecordDeactivation { get; set; }
Property Value
Type Description
System.Boolean

Methods

AddColumn(String)

Adds a new column with the specified type name to the current schema.

Declaration
public EntitySchemaColumn AddColumn(string typeName)
Parameters
Type Name Description
System.String typeName

Column type name.
Returns
Type Description
EntitySchemaColumn

Column of the typeName type.
Remarks

Overloaded method.

AddColumn(String, String)

Adds a new column with the specified type name and column name to the current schema.

Declaration
public EntitySchemaColumn AddColumn(string typeName, string name)
Parameters
Type Name Description
System.String typeName

The name of the type.
System.String name

The name of the column.
Returns
Type Description
EntitySchemaColumn

Column with the name name of the name type.
Remarks

Overloaded method.

AddColumn(String, String, Guid)

Adds a new column with the specified type name, column name and unique identifier to the current schema.

Declaration
public EntitySchemaColumn AddColumn(string typeName, string name, Guid uid)
Parameters
Type Name Description
System.String typeName

The name of the type.
System.String name

The name of the column.
System.Guid uid

Unique identifier of a column.
Returns
Type Description
EntitySchemaColumn

Column with the name name of the name type and the uid identifier.
Remarks

Overloaded method.

AddColumn(String, String, Guid, EntitySchemaColumnRequirementType)

Adds a new column with the specified name, type and unique identifier to the current schema. In this case the verification level of the required values is specified for the column.

Declaration
public EntitySchemaColumn AddColumn(string typeName, string name, Guid uid, EntitySchemaColumnRequirementType requirementType)
Parameters
Type Name Description
System.String typeName

The name of the type.
System.String name

The name of the column.
System.Guid uid

Unique identifier of a column.
EntitySchemaColumnRequirementType requirementType

Verification level of the required values.
Returns
Type Description
EntitySchemaColumn

Column with the name name of the name type, the uid identifier, the requirementType verification level of the required values.
Remarks

Overloaded method.

AddLookupColumn(String, String)

Adds a new column of the lookup type with the specified column name and name of the lookup schema to the current schema.

Declaration
public EntitySchemaColumn AddLookupColumn(string referenceSchemaName, string name)
Parameters
Type Name Description
System.String referenceSchemaName

The name of the lookup schema.
System.String name

The name of the column.
Returns
Type Description
EntitySchemaColumn

The column of the lookup type with the name name of the referenceSchemaName lookup schema.

AddLookupColumn(String, String, Guid)

Adds a new column of the lookup type with the specified name and identifier, which references the specified schema.

Declaration
public EntitySchemaColumn AddLookupColumn(string referenceSchemaName, string name, Guid uid)
Parameters
Type Name Description
System.String referenceSchemaName

The name of the schema that the column references.
System.String name

The name of the column.
System.Guid uid

Unique identifier of a column.
Returns
Type Description
EntitySchemaColumn

The instance of EntitySchemaColumn with the name name, the uid identifier, which references the referenceSchemaName lookup.

AddLookupColumn(String, String, Guid, EntitySchemaColumnRequirementType)

Adds a new column of the lookup type with the specified name, identifier, which references the specified schema. In this case the verification level of the required values is specified for the column.

Declaration
public EntitySchemaColumn AddLookupColumn(string referenceSchemaName, string name, Guid uid, EntitySchemaColumnRequirementType requirementType)
Parameters
Type Name Description
System.String referenceSchemaName

The schema that the given column references.
System.String name

The name of the column.
System.Guid uid

Unique identifier.
EntitySchemaColumnRequirementType requirementType

Type of required parameter.
Returns
Type Description
EntitySchemaColumn

AddSystemLookupColumn(String, String)

Adds a new column of the lookup type with using the column name and name of the system lookup schema.

Declaration
public EntitySchemaColumn AddSystemLookupColumn(string referenceSchemaName, string name)
Parameters
Type Name Description
System.String referenceSchemaName

The name of the system lookup schema.
System.String name

The name of the column.
Returns
Type Description
EntitySchemaColumn

Column of the lookup type with the name name of the referenceSchemaName system lookup schema.

ApplyMetaDataValue(DataReader)

Proofreading the values of the schema properties from the metadata using the specified DataReader.

Declaration
protected override void ApplyMetaDataValue(DataReader reader)
Parameters
Type Name Description
DataReader reader

The DataReader instance that provides metadata proofreading.
Overrides

AssignParentSchema(EntitySchema)

Sets the specified schema as parent.

Declaration
public bool AssignParentSchema(EntitySchema parentSchema)
Parameters
Type Name Description
EntitySchema parentSchema

Schema to be set as parent.

Returns
Type Description
System.Boolean

true, if specified in the parentSchema schema was set as parent. Otherwise returns false.

Clone()

Gets the System.Object instance that is a clone of the current schema.

Declaration
public override object Clone()
Returns
Type Description
System.Object

A System.Object instance that is a clone of the current schema.
Overrides

CloneShallow()

Gets the EntitySchema instance that is a clone of the current schema without columns.

Declaration
public virtual EntitySchema CloneShallow()
Returns
Type Description
EntitySchema

The EntitySchema instance is a clone of the current schema without columns.

CompleteApplyingMetaDataValues()

Finishing initialization of serializable properties of the schema after reading all property values from metadata.

Declaration
protected override void CompleteApplyingMetaDataValues()
Overrides

CreateColumnMap(Boolean)

Declaration
public EntitySchemaColumnMap CreateColumnMap(bool takeDisplayValues)
Parameters
Type Name Description
System.Boolean takeDisplayValues
Returns
Type Description
EntitySchemaColumnMap

CreateEntity(UserConnection)

Creates the instance of the entity described by the schema.

Declaration
public virtual Entity CreateEntity(UserConnection userConnection)
Parameters
Type Name Description
UserConnection userConnection

User connection.
Returns
Type Description
Entity

The Entity instance with data that is built on a current schema.

CreateEventsProcess(UserConnection)

Declaration
public override EmbeddedProcess CreateEventsProcess(UserConnection userConnection)
Parameters
Type Name Description
UserConnection userConnection
Returns
Type Description
EmbeddedProcess
Overrides

CreateGeneralSelect(UserConnection)

Returns a query to retrieve all columns of the current schema, using the specified user connection. The display columns of lookups are not included in this query.

Declaration
public virtual Select CreateGeneralSelect(UserConnection userConnection)
Parameters
Type Name Description
UserConnection userConnection

User connection.
Returns
Type Description
Select

Query to retrieve all columns of the current schema.
Exceptions
Type Condition
System.Security.SecurityException

Insufficient permissions to read information about the specified schema.

CreateSelect(UserConnection, Boolean)

Creates a basic query that retrieves columns of the current schema, using the specified user connection. Depending on the value of the takeDisplayLookupValues parameter, the query can return primary display values from lookups.

Declaration
public virtual Select CreateSelect(UserConnection userConnection, bool takeDisplayLookupValues)
Parameters
Type Name Description
UserConnection userConnection

User connection.
System.Boolean takeDisplayLookupValues

Indicates that the query returns the primary display values. If the parameter is true, the query will return the primary display values.
Returns
Type Description
Select

Query to retrieve columns of the current schema.
Remarks

Method is overloaded.

CreateSelect(UserConnection, Boolean, out EntitySchemaColumnMap)

Creates a basic query to retrieve values of all columns of the current schema, using the specified user connection, and returning a map of columns. Depending on the takeDisplayLookupValues parameter, the query results can return the primary display values.

Declaration
public virtual Select CreateSelect(UserConnection userConnection, bool takeDisplayLookupValues, out EntitySchemaColumnMap columnMap)
Parameters
Type Name Description
UserConnection userConnection

User connection.
System.Boolean takeDisplayLookupValues

Indicates that the query returns the primary display values. If the parameter is true, the query will return the primary display values.
EntitySchemaColumnMap columnMap

Map of columns for the created query.
Returns
Type Description
Select

Query to retrieve columns of the current schema.
Remarks

Method is overloaded.

CreateSelect(UserConnection, IEnumerable<EntitySchemaColumn>, Boolean)

Creates a basic query that retrieves values of the specified enumerator of columns of the current schema, using the specified user connection. Depending on the value of the takeDisplayLookupValues parameter, the query can return primary display values from lookups.

Declaration
public virtual Select CreateSelect(UserConnection userConnection, IEnumerable<EntitySchemaColumn> columns, bool takeDisplayLookupValues)
Parameters
Type Name Description
UserConnection userConnection

User connection.
System.Collections.Generic.IEnumerable<EntitySchemaColumn> columns

Columns that are to be returned in query results.
System.Boolean takeDisplayLookupValues

Indicates that the query returns the primary display values. If the parameter is true, the query will return the primary display values.
Returns
Type Description
Select

Query to retrieve columns of the current schema.
Remarks

Method is overloaded.

CreateSelect(UserConnection, IEnumerable<EntitySchemaColumn>, Boolean, out EntitySchemaColumnMap)

Creates a basic query to retrieve the specified enumerator of the schema columns, using the specified user connection, and returning a map of columns. Depending on the value of the takeDisplayLookupValues parameter, the query can return primary display values from lookups.

Declaration
public virtual Select CreateSelect(UserConnection userConnection, IEnumerable<EntitySchemaColumn> columns, bool takeDisplayLookupValues, out EntitySchemaColumnMap columnMap)
Parameters
Type Name Description
UserConnection userConnection

User connection.
System.Collections.Generic.IEnumerable<EntitySchemaColumn> columns

Columns that are to be returned in query results.
System.Boolean takeDisplayLookupValues

Indicates that the query returns the primary display values. If the parameter is true, the query will return the primary display values.
EntitySchemaColumnMap columnMap

Map of columns for the created query.
Returns
Type Description
Select

Query to retrieve columns of the current schema.
Remarks

Method is overloaded.

Exceptions
Type Condition
System.Security.SecurityException

Insufficient permissions to read information about the specified schema.
NullOrEmptyException

If the list of the schemas from which values are taken is not specified for the primary display values or if one of these schemas is not initialized.

CreateSelectWithoutRights(UserConnection, IEnumerable<EntitySchemaColumn>, Boolean, out EntitySchemaColumnMap)

Declaration
public virtual Select CreateSelectWithoutRights(UserConnection userConnection, IEnumerable<EntitySchemaColumn> columns, bool takeDisplayLookupValues, out EntitySchemaColumnMap columnMap)
Parameters
Type Name Description
UserConnection userConnection
System.Collections.Generic.IEnumerable<EntitySchemaColumn> columns
System.Boolean takeDisplayLookupValues
EntitySchemaColumnMap columnMap
Returns
Type Description
Select

CreateTrackChangesInsertSelect(UserConnection, Object, EntityChangeType)

Returns the request to save a record to the change log if the it is kept for the schema.

Declaration
public InsertSelect CreateTrackChangesInsertSelect(UserConnection userConnection, object primaryColumnValue, EntityChangeType changeType)
Parameters
Type Name Description
UserConnection userConnection

User connection.
System.Object primaryColumnValue
EntityChangeType changeType

Type of editing the entity – object.
Returns
Type Description
InsertSelect

Request to save a record to a change log of the current schema.

FindPrimaryDisplayColumnName()

Determines whether the current schema contains a primary display column.

Declaration
public string FindPrimaryDisplayColumnName()
Returns
Type Description
System.String

The name of the primary display column or null if this column is not specified for the schema.

FindSchemaColumnByMetaPath(String)

Finds schema column by it's meta path.

Declaration
public virtual EntitySchemaColumn FindSchemaColumnByMetaPath(string columnMetaPath)
Parameters
Type Name Description
System.String columnMetaPath

Column meta path.
Returns
Type Description
EntitySchemaColumn

Entity schema column.

FindSchemaColumnByPath(String)

Converts the specified path to column into actual path, while accounting for type of inheritance, and returns the matched column to it.

Declaration
public virtual EntitySchemaColumn FindSchemaColumnByPath(string columnPath)
Parameters
Type Name Description
System.String columnPath

Path to schema column.
Returns
Type Description
EntitySchemaColumn

Column that actually matched the columnPath path.
Exceptions
Type Condition
ArgumentNullOrEmptyException

If the empty value or null value is passed as the columnPath parameter.
InvalidTypeCastException

If the column is not the lookup type column.
InvalidObjectStateException

If the list of lookup schemas is not specified for the column of the lookup type.
InvalidObjectStateException

Reference to the lookup schema is not specified for the column of the lookup type.

FindSchemaColumnPathByMetaPath(String)

By the specified meta path to the schema column, generates the string of actual path that is built based on the type of inheritance.

Declaration
public string FindSchemaColumnPathByMetaPath(string columnMetaPath)
Parameters
Type Name Description
System.String columnMetaPath

Meta path to column.
Returns
Type Description
System.String

String of actual path to column that matches the columnMetaPath meta path.
Exceptions
Type Condition
InvalidObjectStateException

If the column is not the lookup type column.
InvalidObjectStateException

If the reference to the lookup schema is not specified for the column of the lookup type.

FindSchemaColumnsByPath(String)

Declaration
public List<EntitySchemaColumn> FindSchemaColumnsByPath(string columnPath)
Parameters
Type Name Description
System.String columnPath
Returns
Type Description
System.Collections.Generic.List<EntitySchemaColumn>

GenerateMobileBody()

Declaration
[Obsolete("Метод устарел и будет удален")]
public string GenerateMobileBody()
Returns
Type Description
System.String

GetDBPrimaryColumn()

Returns the primary column for the current schema. If the column is not found, the exception is thrown.

Declaration
public EntitySchemaColumn GetDBPrimaryColumn()
Returns
Type Description
EntitySchemaColumn

If the schema is derived independently, the primary column of the current schema will be returned. In one-to-one inheritance, the column of relationship with the parent of the current schema will be returned.
Exceptions
Type Condition
NullOrEmptyException

If either the primary column or column of the parent relationship is not specified for the current schema.

GetDBPrimaryColumnName()

Name of the primary column of the given schema in the database table.

Declaration
public string GetDBPrimaryColumnName()
Returns
Type Description
System.String

Name of the column in the database table that matches the primary column of the schema.
Exceptions
Type Condition
NullOrEmptyException

If the primary column is not initialized for the given schema.
NullOrEmptyException

If the name of the primary column of the given schema is empty or null.
NullOrEmptyException

If the parent relationship column for the one-to-one inheritance is not initialized for the given schema.
NullOrEmptyException

If the name of the parent relationship column of the given schema is empty or null.

GetEntitySchemaByKind(EntitySchemaKind)

Gets the schema instance matching the specified type of the system schema.

Declaration
public EntitySchema GetEntitySchemaByKind(EntitySchemaKind kind)
Parameters
Type Name Description
EntitySchemaKind kind

Schema type.
Returns
Type Description
EntitySchema

The EntitySchema instance of the kind type.

GetFirstSchemaColumnNameByPath(String)

Declaration
public string GetFirstSchemaColumnNameByPath(string columnPath)
Parameters
Type Name Description
System.String columnPath
Returns
Type Description
System.String

GetInactiveColumn()

Returns RecordDisabled column instance.

Declaration
public EntitySchemaColumn GetInactiveColumn()
Returns
Type Description
EntitySchemaColumn

EntitySchemaColumn instance.

GetIsPrefixRequired()

Declaration
protected override bool GetIsPrefixRequired()
Returns
Type Description
System.Boolean
Overrides

GetKindSuffix()

Gets the suffix associated with the type of the current schema that is used for generating unique names of database system entities.

Declaration
public string GetKindSuffix()
Returns
Type Description
System.String

Suffix associated with the type of the current schema.

GetLocalizableValues(ICollection<LocalizableValue>, Boolean)

Declaration
public override void GetLocalizableValues(ICollection<LocalizableValue> values, bool includeInherited)
Parameters
Type Name Description
System.Collections.Generic.ICollection<LocalizableValue> values
System.Boolean includeInherited
Overrides

GetLocalizationSchema()

Returns localization schema for current schema.

Declaration
public EntitySchema GetLocalizationSchema()
Returns
Type Description
EntitySchema

The instance of the EntitySchema class, that provides localization schema for current schema.

GetMetaItems(ICollection<IMetaItem>)

Fills the passed collection with all the meta-elements of the current schema. MetaItem.

Declaration
public override void GetMetaItems(ICollection<IMetaItem> metaItems)
Parameters
Type Name Description
System.Collections.Generic.ICollection<IMetaItem> metaItems

Collection that is populated with meta items of the current schema.
Overrides

GetMobileBody()

Declaration
[Obsolete("Метод устарел и будет удален")]
public virtual string GetMobileBody()
Returns
Type Description
System.String

GetMultiLookupPathParts(String)

From the specified path to lookup column of the schema, generates the array of actual path strings that are built, while accounting for inheritance.

Declaration
public string[] GetMultiLookupPathParts(string columnPath)
Parameters
Type Name Description
System.String columnPath

Path to schema column.
Returns
Type Description
System.String[]

String array of the path to the primary display column that is converted, while accounting for inheritance.

GetPrimaryColumnName()

Returns the name of the primary column of the given schema at the database level.

Declaration
public string GetPrimaryColumnName()
Returns
Type Description
System.String

Name of the primary column of schema.

GetPrimaryDisplayColumn()

Returns the primary display column.

Declaration
public EntitySchemaColumn GetPrimaryDisplayColumn()
Returns
Type Description
EntitySchemaColumn

Primary display column.

GetPrimaryDisplayColumnName()

Returns the primary display column. If the same column is not specified for the schema, the exception is thrown.

Declaration
public string GetPrimaryDisplayColumnName()
Returns
Type Description
System.String

Name of the primary display column.
Exceptions
Type Condition
NullOrEmptyException

If the primary display column is not initialized for the given schema or if the name is empty or null.

GetResourceManagerName()

Declaration
public override string GetResourceManagerName()
Returns
Type Description
System.String
Overrides

GetSchemaColumnByMetaPath(String)

Converts the specified meta path to column into actual path, while accounting for type of inheritance, and returns the matched column to it. If the column is not found, the exception is thrown.

Declaration
public virtual EntitySchemaColumn GetSchemaColumnByMetaPath(string columnMetaPath)
Parameters
Type Name Description
System.String columnMetaPath

Meta path to column.
Returns
Type Description
EntitySchemaColumn

Column that actually matched the columnMetaPath meta path.
Exceptions
Type Condition
ArgumentNullOrEmptyException

If the empty value or null value is passed as the columnMetaPath parameter.
InvalidObjectStateException

If the column is not the lookup type column.
InvalidObjectStateException

If the reference to the lookup schema is not specified for the column of the lookup type.

GetSchemaColumnByPath(String)

Converts the specified path to column into actual path, while accounting for type of inheritance, and returns the matched column to it. If the column is not found, the exception is thrown.

Declaration
public virtual EntitySchemaColumn GetSchemaColumnByPath(string columnPath)
Parameters
Type Name Description
System.String columnPath

Path to schema column.
Returns
Type Description
EntitySchemaColumn

Column that actually matched the columnPath path.
Exceptions
Type Condition
ItemNotFoundException

If the actual path generated for columnPath does not find a column.

GetSchemaColumnFullCaptionByPath(String, String)

From the specified path to column generates the full caption of column, using the specified delimiter.

Declaration
public LocalizableString GetSchemaColumnFullCaptionByPath(string columnPath, string delimiter = ".")
Parameters
Type Name Description
System.String columnPath

Path to schema column.
System.String delimiter

Delimiter.
Returns
Type Description
LocalizableString

String that represents the full caption of the column that is specified in columnPath using the delimiter delimiter.
Exceptions
Type Condition
ArgumentNullOrEmptyException

If the empty value or null value is passed as the columnPath parameter.
InvalidObjectStateException

If the column is not the lookup type column.
InvalidObjectStateException

If the reference to the lookup schema is not specified for the column of the lookup type.

GetSchemaColumnMetaPathByPath(String)

From the specified actual path to column generates the string of meta path to this column.

Declaration
public string GetSchemaColumnMetaPathByPath(string columnPath)
Parameters
Type Name Description
System.String columnPath

Actual path to the column.
Returns
Type Description
System.String

Meta path to the column. specified by columnPath.

GetSchemaColumnPathByMetaPath(String)

By the specified meta path to the schema column, generates the string of actual path that is built based on the type of inheritance.

Declaration
public string GetSchemaColumnPathByMetaPath(string columnMetaPath)
Parameters
Type Name Description
System.String columnMetaPath

Meta path to column.
Returns
Type Description
System.String

String of actual path to column that matches the columnMetaPath meta path.
Exceptions
Type Condition
ArgumentNullOrEmptyException

If the empty value or null value is passed as the columnMetaPath parameter.
InvalidObjectStateException

If the column is not the lookup type column.
InvalidObjectStateException

If the reference to the lookup schema is not specified for the column of the lookup type.

GetSchemaColumnReversePathByPath(String)

From the specified path to column generates the actual path string with inverse associations.

Declaration
public string GetSchemaColumnReversePathByPath(string columnPath)
Parameters
Type Name Description
System.String columnPath

Path to schema column.
Returns
Type Description
System.String

Path with inverse associations to schema column, which matches columnPath.
Exceptions
Type Condition
ArgumentNullOrEmptyException

If the empty value or null is specified as the columnPath parameter.
InvalidTypeCastException

If the column is not the lookup type column.
InvalidObjectStateException

Reference to the lookup schema is not specified for the column of the lookup type.
InvalidObjectStateException

The column must be the lookup column.
InvalidObjectStateException

If the reference to the lookup schema is not specified for the column of the lookup type.
InvalidObjectStateException

If the primary column is not specified for the column of the lookup type.

GetTrackChangesInDBSchema()

Returns schema for logging the current schema.

Declaration
public EntitySchema GetTrackChangesInDBSchema()
Returns
Type Description
EntitySchema

The EntitySchema instance dedicated to logging changes in the current schema.

GetTrackChangesInDBSchemaName()

Returns the schema name for logging.

Declaration
public string GetTrackChangesInDBSchemaName()
Returns
Type Description
System.String

Name of schema used for logging the current schema.

InitializeColumns()

Initialization of columns.

Declaration
protected virtual void InitializeColumns()

InitializeColumnsLocalizableValues()

Initialization of localizable values of columns.

Declaration
protected virtual void InitializeColumnsLocalizableValues()

InitializeCreatedByColumn()

Initialization of column for storing reference to contact that created the record.

Declaration
protected virtual void InitializeCreatedByColumn()

InitializeCreatedInSchemaUId()

For the inherited columns of the given schema sets the unique identifier of the schema in which these columns have been created.

Declaration
public override void InitializeCreatedInSchemaUId()
Overrides

InitializeCreatedOnColumn()

Initialization of column for storing the creation date.

Declaration
protected virtual void InitializeCreatedOnColumn()

InitializeEventsProcessSchema()

Declaration
protected override void InitializeEventsProcessSchema()
Overrides

InitializeHierarchyColumn()

Initialization of column of the parent record relationship for hierarchical entities.

Declaration
protected virtual void InitializeHierarchyColumn()

InitializeInactiveColumn(Lazy<EntitySchemaColumnCollection>)

Declaration
protected virtual void InitializeInactiveColumn(Lazy<EntitySchemaColumnCollection> columns)
Parameters
Type Name Description
System.Lazy<EntitySchemaColumnCollection> columns

InitializeIndexes()

Initialization of indexes.

Declaration
protected virtual void InitializeIndexes()

InitializeLocalizableValues(String, String)

Performs initialization of localizable values from specified group resourceGroupName in resourceManagerName resource manager.

Declaration
public override void InitializeLocalizableValues(string resourceManagerName, string resourceGroupName = null)
Parameters
Type Name Description
System.String resourceManagerName

Resource manager name.
System.String resourceGroupName

Resource group name.
Overrides

InitializeMasterRecordColumn()

MasterRecordColumn property initialization.

Declaration
protected virtual void InitializeMasterRecordColumn()

InitializeModifiedByColumn()

Initialization of column determining who has modified the schema.

Declaration
protected virtual void InitializeModifiedByColumn()

InitializeModifiedInSchemaUId()

For the inherited columns of the given schema sets the unique identifier of the schema in which these columns have been modified.

Declaration
public override void InitializeModifiedInSchemaUId()
Overrides

InitializeModifiedOnColumn()

Initialization of column for storing the schema modified date.

Declaration
protected virtual void InitializeModifiedOnColumn()

InitializeOneToOneParentAssociationColumn()

Initialization of a parent relationship column for the one-to-one inheritance.

Declaration
[Obsolete("7.12.0 | Method is not in use and will be removed in upcoming builds")]
protected virtual void InitializeOneToOneParentAssociationColumn()

InitializeOwnerAdminUnitColumn()

Declaration
protected virtual void InitializeOwnerAdminUnitColumn()

InitializeOwnerColumn()

Initialization of column of the record owner.

Declaration
protected virtual void InitializeOwnerColumn()

InitializePredefinedColumnsLocalizableValues(Boolean)

Initialization of fixed localizable values of columns.

Declaration
protected void InitializePredefinedColumnsLocalizableValues(bool resetCachedValues = false)
Parameters
Type Name Description
System.Boolean resetCachedValues

InitializePrimaryColorColumn()

Declaration
protected virtual void InitializePrimaryColorColumn()

InitializePrimaryColumn()

Initialization of a column with the primary key of the schema.

Declaration
protected virtual void InitializePrimaryColumn()

InitializePrimaryDisplayColumn()

Initialization of a primary column for displaying data.

Declaration
protected virtual void InitializePrimaryDisplayColumn()

InitializePrimaryImageColumn()

Initialization of a primary column for displaying images.

Declaration
protected virtual void InitializePrimaryImageColumn()

InitializePrimaryInfo()

Initializes primary properties of the given schema.

Declaration
public override void InitializePrimaryInfo()
Overrides
Exceptions
Type Condition
InvalidObjectStateException

If the name of the given schema is empty or null.

InitializePrimaryOrderColumn()

Initialization of a primary column for sorting.

Declaration
protected virtual void InitializePrimaryOrderColumn()

InitializeProperties()

Initialization of schema properties.

Declaration
protected virtual void InitializeProperties()

InitializeQueries()

Declaration
protected virtual void InitializeQueries()

InitializeRuntimeGeneratedColumns()

Declaration
public virtual void InitializeRuntimeGeneratedColumns()

ReadMetaData(DataReader)

Reads the schema from metadata, using the specified DataReader instance.

Declaration
public override void ReadMetaData(DataReader reader)
Parameters
Type Name Description
DataReader reader

The DataReader instance that reads metadata of the schema.
Overrides
Exceptions
Type Condition
InvalidObjectStateException

ReInitializeLocalizableValues(String, String)

Performs reinitialization of localizable values from specified group resourceGroupName in resourceManagerName resource manager.

Declaration
public override void ReInitializeLocalizableValues(string resourceManagerName, string resourceGroupName = null)
Parameters
Type Name Description
System.String resourceManagerName

Resource manager name.
System.String resourceGroupName

Resource group name.
Overrides

SetColumnsDefInheritance(Guid)

Sets the passed schema identifier for all columns for which the schema where they have been created is not specified.

Declaration
protected void SetColumnsDefInheritance(Guid schemaUId)
Parameters
Type Name Description
System.Guid schemaUId

Unique identifier of schema where the columns were created.

SetDefInheritance()

Sets the current schema identifier as the parent for all schema elements that do not have a parent schema identifier.

Declaration
public override void SetDefInheritance()
Overrides

ValidateNames(Boolean)

Checks current schema and its elements validity.

Declaration
public void ValidateNames(bool validatePrefixes = true)
Parameters
Type Name Description
System.Boolean validatePrefixes

true for names prefixes validation. Othervise - false.
Exceptions
Type Condition
InvalidNameException

Raises when schema or schema elements are invalid.

WriteMetaData(DataWriter)

Records schema metadata using the DataWriter instance.

Declaration
public override void WriteMetaData(DataWriter writer)
Parameters
Type Name Description
DataWriter writer

The DataWriter instance that writes schema metadata.
Overrides

Implements

System.ICloneable

Extension Methods