Class EntitySchema
Представляет схему объекта.
Inheritance
Implements
Inherited Members
Namespace: Terrasoft.Core.Entities
Assembly: Terrasoft.Core.dll
Syntax
[MetaType("{2E75BAEF-633F-498c-8A89-0F2D9DB4D568}")]
public class EntitySchema : ProcessBasedSchema, IMetaDataSerializable, ICloneable, IMetaSchema, IMetaItem, IManagerItemInstance, ISchemaManagerSchema<EntitySchema>
Constructors
EntitySchema(EntitySchema)
Инициализирует новый экземпляр EntitySchema, являющийся полным клоном заданной схемы
source
.
Declaration
public EntitySchema(EntitySchema source)
Parameters
Type | Name | Description |
---|---|---|
EntitySchema | source | Схема, клон которой создается. |
EntitySchema(EntitySchema, Boolean)
Инициализирует новый экземпляр EntitySchema, являющийся полным или неполным клоном
заданной схемы source
в зависимости от значения isShallowClone
.
Declaration
public EntitySchema(EntitySchema source, bool isShallowClone)
Parameters
Type | Name | Description |
---|---|---|
EntitySchema | source | Схема, клон которой создается. |
System.Boolean | isShallowClone | Признак полноты клонирования схемы. Если |
EntitySchema(EntitySchemaManager)
Инициализирует новый экземпляр EntitySchema с заданным менеджером схем.
Declaration
public EntitySchema(EntitySchemaManager entitySchemaManager)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaManager | entitySchemaManager | Менеджер схем. |
Properties
AdministratedByColumns
Признак администрирования схемы по колонкам.
Declaration
[MetaTypeProperty("{43FF0622-7255-43C7-A175-5491A56A998F}", IsExtraProperty = true)]
public bool AdministratedByColumns { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AdministratedByOperations
Признак администрирования схемы по операциям.
Declaration
[MetaTypeProperty("{E897E7E7-6D35-4820-AD76-9D6B8EEDF1EC}", IsExtraProperty = true)]
public bool AdministratedByOperations { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AdministratedByRecords
Признак администрирования схемы по записям.
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
Признак автоматической инициализации колонок.
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
Коллекция колонок схемы.
Declaration
[MetaTypeProperty("{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumnCollection Columns { get; }
Property Value
Type | Description |
---|---|
EntitySchemaColumnCollection |
CreatedByColumn
Колонка для хранения ссылки на контакт, который создал запись.
Declaration
[MetaTypeProperty("{5FD383BA-C0EF-42E5-AAF2-21340CBF1736}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn CreatedByColumn { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaColumn |
CreatedOnColumn
Колонка для хранения даты создания записи.
Declaration
[MetaTypeProperty("{BF96BE34-BF05-4FAC-92AC-E51013FCC905}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn CreatedOnColumn { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaColumn |
DataValueTypeManager
Менеджер типов данных колонок схемы.
Declaration
public DataValueTypeManager DataValueTypeManager { get; }
Property Value
Type | Description |
---|---|
DataValueTypeManager |
DBInheritanceType
Тип наследования схемы на уровне базы данных.
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
Признак удаления записи из родительской схемы при удалении текущей записи, если схема наследуется один к одному.
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
Менеджер схем объектов.
Declaration
public EntitySchemaManager EntitySchemaManager { get; }
Property Value
Type | Description |
---|---|
EntitySchemaManager |
Events
События схемы.
Declaration
public EntitySchemaEvents Events { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaEvents |
HasEvents
Признак наличия событий для данной схемы.
Declaration
public bool HasEvents { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
HasIndependentProcessListeners
Признак определения для схемы своих завершающих условий элементов процессов, отличных от системных.
Declaration
[MetaTypeProperty("{2210C239-82AC-468F-91C2-5E154807112D}", DefValue = false)]
public bool HasIndependentProcessListeners { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
HierarchyColumn
Колонка связи с родительской записью для иерархических объектов. Используется для построения иерархических запросов.
Declaration
[MetaTypeProperty("{E1453316-7782-4879-84FE-F5A52BF1B575}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn HierarchyColumn { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaColumn |
Indexes
Коллекция индексов схемы.
Declaration
[MetaTypeProperty("{B3318A2E-51CB-44b2-B69F-7C67EA7E1BD4}")]
public EntitySchemaIndexCollection Indexes { get; }
Property Value
Type | Description |
---|---|
EntitySchemaIndexCollection |
IsDBView
Признак, является ли схема представлением в базе данных.
Declaration
[MetaTypeProperty("{CA155F3F-FCEB-4989-8155-8E987238734C}")]
public bool IsDBView { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsDynamicallyCreated
Признак динамически созданной схемы.
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
Признак журналируемости схемы.
Declaration
[MetaTypeProperty("{D3FA0A53-F081-43E1-B394-2700B46AF89B}", DefValue = false, IsExtraProperty = true)]
public bool IsTrackChangesInDB { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsVirtual
Признак виртуальности схемы.
Declaration
[MetaTypeProperty("{E922C759-381C-4679-A9D9-48A95AEBDF34}", IsExtraProperty = true)]
public bool IsVirtual { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Kind
Тип схемы.
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
Колонка для хранения ссылки на контакт, который модифицировал запись.
Declaration
[MetaTypeProperty("{039F18C9-9A3C-4532-91CD-599C52720A8B}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn ModifiedByColumn { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaColumn |
ModifiedOnColumn
Колонка для хранения даты модификации записи.
Declaration
[MetaTypeProperty("{35EF0216-88CE-41D8-A4BC-9FDF9F8B34A1}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn ModifiedOnColumn { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaColumn |
OneToOneParentAssociationColumn
Колонка связи с родителем при наследовании один к одному.
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 |
OwnerColumn
Колонка, указывающая на владельца. Используется для раздачи прав на запись владельцу.
Declaration
[MetaTypeProperty("{CFF235A3-A968-46B3-A642-CB942C67E891}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn OwnerColumn { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaColumn |
ParentSchema
Родительская схема.
Declaration
public EntitySchema ParentSchema { get; set; }
Property Value
Type | Description |
---|---|
EntitySchema |
ParentSchemaUId
Уникальный идентификатор родительской схемы.
Declaration
[DBMetaTypeProperty(DBMetaInfoItemType.Schema, typeof(GuidDBMetaTypeConverter))]
public Guid ParentSchemaUId { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
PrimaryColumn
Колонка, представляющая первичный ключ.
Declaration
[MetaTypeProperty("{A71B72FE-76FA-4047-BD46-87121A70B188}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn PrimaryColumn { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaColumn |
PrimaryDisplayColumn
Первичная колонка для отображения данных.
Declaration
[MetaTypeProperty("{068A7874-3656-497b-B9B5-7C489A87FF9C}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn PrimaryDisplayColumn { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaColumn |
PrimaryImageColumn
Первичная колонка для отображения изображения.
Declaration
[MetaTypeProperty("{6FD012E3-64EA-4ba0-BA59-91D0F5E7B2AA}", "{8ED2B55D-0442-4d2a-8FCF-65E2118515B6}")]
public EntitySchemaColumn PrimaryImageColumn { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaColumn |
PrimaryOrderColumn
Первичная колонка для сортировки.
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 |
SystemEntitySchemaManager
Менеджер системных схем объектов.
Declaration
public SystemEntitySchemaManager SystemEntitySchemaManager { get; }
Property Value
Type | Description |
---|---|
SystemEntitySchemaManager |
SystemNameAdditionalLength
Declaration
public static int SystemNameAdditionalLength { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
SystemValueManager
Менеджер системных значений.
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
Признак использования запрещающих прав для схемы.
Declaration
[MetaTypeProperty("{E112AEFA-7D99-45FA-8621-0F26B3B85450}", DefValue = false)]
public bool UseDenyRecordRights { 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)
Добавляет в текущую схему новую колонку с указанным именем типа.
Declaration
public EntitySchemaColumn AddColumn(string typeName)
Parameters
Type | Name | Description |
---|---|---|
System.String | typeName | Имя типа колонки. |
Returns
Type | Description |
---|---|
EntitySchemaColumn | Колонка типа |
Remarks
Перегруженный метод.
AddColumn(String, String)
Добавляет в текущую схему новую колонку с указанными именем типа и именем колонки.
Declaration
public EntitySchemaColumn AddColumn(string typeName, string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | typeName | Имя типа. |
System.String | name | Имя колонки. |
Returns
Type | Description |
---|---|
EntitySchemaColumn | Колонка с именем |
Remarks
Перегруженный метод.
AddColumn(String, String, Guid)
Добавляет в текущую схему новую колонку с указанными именем колонки, именем типа и уникальным идентификатором.
Declaration
public EntitySchemaColumn AddColumn(string typeName, string name, Guid uid)
Parameters
Type | Name | Description |
---|---|---|
System.String | typeName | Имя типа. |
System.String | name | Имя колонки. |
System.Guid | uid | Уникальный идентификатор колонки. |
Returns
Type | Description |
---|---|
EntitySchemaColumn | Колонка с именем |
Remarks
Перегруженный метод.
AddColumn(String, String, Guid, EntitySchemaColumnRequirementType)
Добавляет в текущую схему новую колонку с указанными именем, типом и уникальным идентификатором. При этом для колонки указывается уровень проверки значений, обязательных для заполнения.
Declaration
public EntitySchemaColumn AddColumn(string typeName, string name, Guid uid, EntitySchemaColumnRequirementType requirementType)
Parameters
Type | Name | Description |
---|---|---|
System.String | typeName | Имя типа. |
System.String | name | Имя колонки. |
System.Guid | uid | Уникальный идентификатор колонки. |
EntitySchemaColumnRequirementType | requirementType | Уровень проверки обязательных значений. |
Returns
Type | Description |
---|---|
EntitySchemaColumn | Колонка с именем |
Remarks
Перегруженный метод.
AddLookupColumn(String, String)
Добавляет в текущую схему новую колонку типа справочник с указанными именем колонки и именем схемы-справочника.
Declaration
public EntitySchemaColumn AddLookupColumn(string referenceSchemaName, string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | referenceSchemaName | Имя схемы-справочника. |
System.String | name | Имя колонки. |
Returns
Type | Description |
---|---|
EntitySchemaColumn | Колонка типа справочник с именем |
AddLookupColumn(String, String, Guid)
Добавляет новую колонку типа справочник с указанными именем и идентификатором, которая ссылается на заданную схему.
Declaration
public EntitySchemaColumn AddLookupColumn(string referenceSchemaName, string name, Guid uid)
Parameters
Type | Name | Description |
---|---|---|
System.String | referenceSchemaName | Имя схемы, на которую ссылается колонка. |
System.String | name | Имя колонки. |
System.Guid | uid | Уникальный идентификатор колонки. |
Returns
Type | Description |
---|---|
EntitySchemaColumn | Экземпляр EntitySchemaColumn с именем |
AddLookupColumn(String, String, Guid, EntitySchemaColumnRequirementType)
Добавляет новую колонку типа справочник с указанными именем, идентификатором, которая ссылается на заданную схему. При этом для колонки указывается уровень проверки значений, обязательных для заполнения.
Declaration
public EntitySchemaColumn AddLookupColumn(string referenceSchemaName, string name, Guid uid, EntitySchemaColumnRequirementType requirementType)
Parameters
Type | Name | Description |
---|---|---|
System.String | referenceSchemaName | Схема, на которую ссылается данная колонка. |
System.String | name | Имя колонки. |
System.Guid | uid | Уникальный идентификатор. |
EntitySchemaColumnRequirementType | requirementType | Тип обязательности параметра. |
Returns
Type | Description |
---|---|
EntitySchemaColumn |
AddSystemLookupColumn(String, String)
Добавляет в текущую схему новую колонку типа справочник с указанием имени колонки и имени системной схемы-справочника.
Declaration
public EntitySchemaColumn AddSystemLookupColumn(string referenceSchemaName, string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | referenceSchemaName | Имя системной схемы-справочника. |
System.String | name | Имя колонки. |
Returns
Type | Description |
---|---|
EntitySchemaColumn | Колонка типа справочник с именем |
ApplyMetaDataValue(DataReader)
Вычитка значений свойств схемы из метаданных с помощью заданного DataReader.
Declaration
protected override void ApplyMetaDataValue(DataReader reader)
Parameters
Type | Name | Description |
---|---|---|
DataReader | reader | Экземпляр |
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 |
|
Clone()
Возвращает экземпляр System.Object, являющийся клоном текущей схемы.
Declaration
public override object Clone()
Returns
Type | Description |
---|---|
System.Object | Экземпляр System.Object, являющийся клоном текущей схемы. |
Overrides
CloneShallow()
Возвращает экземпляр EntitySchema, являющийся клоном текущей схемы без колонок.
Declaration
public virtual EntitySchema CloneShallow()
Returns
Type | Description |
---|---|
EntitySchema | Экземпляр EntitySchema - клон текущей схемы без колонок. |
CompleteApplyingMetaDataValues()
Завершение инициализации сериализуемых свойств схемы после вычитки всех значений свойств из метаданных.
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)
Создает экземпляр объекта, который описывает схема.
Declaration
public virtual Entity CreateEntity(UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
Returns
Type | Description |
---|---|
Entity | Экземпляр Entity с данными, построенный по текущей схеме. |
CreateEventsProcess(UserConnection)
Declaration
public override EmbeddedProcess CreateEventsProcess(UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection |
Returns
Type | Description |
---|---|
EmbeddedProcess |
Overrides
CreateGeneralSelect(UserConnection)
Возвращает запрос для получения всех колонок текущей схемы, используя заданное пользовательское подключение. В этот запрос не включаются отображаемые колонки справочников.
Declaration
public virtual Select CreateGeneralSelect(UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
Returns
Type | Description |
---|---|
Select | Запрос для получения всех колонок текущей схемы. |
Exceptions
Type | Condition |
---|---|
System.Security.SecurityException | Недостаточно прав для чтения информации по данной схеме. |
CreateSelect(UserConnection, Boolean)
Создает базовый запрос для получения колонок текущей схемы, используя заданное пользовательское подключение.
В зависимости от значения параметра takeDisplayLookupValues
в запросе могут возвращаться
первичные отображаемые значения из справочников.
Declaration
public virtual Select CreateSelect(UserConnection userConnection, bool takeDisplayLookupValues)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
System.Boolean | takeDisplayLookupValues | Признак получения в запросе первичных отображаемых значений.
Если параметр равен |
Returns
Type | Description |
---|---|
Select | Запрос для получения колонок текущей схемы. |
Remarks
Метод перегружен.
CreateSelect(UserConnection, Boolean, out EntitySchemaColumnMap)
Создает базовый запрос для получения значений всех колонок текущей схемы, используя заданное
пользовательское подключение, возвращая при этом карту колонок. В зависимости от параметра
takeDisplayLookupValues
в запросе могут возвращаться первичные отображаемые значения.
Declaration
public virtual Select CreateSelect(UserConnection userConnection, bool takeDisplayLookupValues, out EntitySchemaColumnMap columnMap)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
System.Boolean | takeDisplayLookupValues | Признак получения в запросе первичных отображаемых значений.
Если параметр равен |
EntitySchemaColumnMap | columnMap | Карта колонок по созданному запросу. |
Returns
Type | Description |
---|---|
Select | Запрос для получения колонок текущей схемы. |
Remarks
Метод перегружен.
CreateSelect(UserConnection, IEnumerable<EntitySchemaColumn>, Boolean)
Создает базовый запрос для получения значений заданного перечислителя колонок текущей схемы, используя
заданное пользовательское подключение. В зависимости от значения параметра
takeDisplayLookupValues
в запросе могут возвращаться первичные отображаемые значения из
справочников.
Declaration
public virtual Select CreateSelect(UserConnection userConnection, IEnumerable<EntitySchemaColumn> columns, bool takeDisplayLookupValues)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
System.Collections.Generic.IEnumerable<EntitySchemaColumn> | columns | Колонки, которые должны быть возвращены в запросе. |
System.Boolean | takeDisplayLookupValues | Признак получения в запросе первичных отображаемых значений.
Если параметр равен |
Returns
Type | Description |
---|---|
Select | Запрос для получения колонок текущей схемы. |
Remarks
Метод перегружен.
CreateSelect(UserConnection, IEnumerable<EntitySchemaColumn>, Boolean, out EntitySchemaColumnMap)
Создает базовый запрос для получения заданного перечислителя колонок схемы, используя заданное
пользовательское подключение, возвращая при этом карту колонок. В зависимости от значения параметра
takeDisplayLookupValues
в запросе могут возвращаться первичные отображаемые значения
из справочников.
Declaration
public virtual Select CreateSelect(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 | Запрос для получения колонок текущей схемы. |
Remarks
Метод перегружен.
Exceptions
Type | Condition |
---|---|
System.Security.SecurityException | Недостаточно прав для чтения информации о данной схеме. |
CreateTrackChangesInsertSelect(UserConnection, Object, EntityChangeType)
Возвращает запрос на сохранение записи в журнале, если схема является журналируемой.
Declaration
public InsertSelect CreateTrackChangesInsertSelect(UserConnection userConnection, object primaryColumnValue, EntityChangeType changeType)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
System.Object | primaryColumnValue | |
EntityChangeType | changeType | Тип изменения сущности - объекта. |
Returns
Type | Description |
---|---|
InsertSelect | Запрос на сохранение записи в журнале изменений по текущей схеме. |
FindPrimaryDisplayColumnName()
Определяет наличие у текущей схемы первичной колонки для отображения.
Declaration
public string FindPrimaryDisplayColumnName()
Returns
Type | Description |
---|---|
System.String | Имя первичной колонки для отображения либо |
FindSchemaColumnByMetaPath(String)
Преобразует заданный метапуть к колонке к фактическому пути с учетом наследования схемы и возвращает соответствующую ему колонку.
Declaration
public virtual EntitySchemaColumn FindSchemaColumnByMetaPath(string columnMetaPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnMetaPath | Метапуть к колонке. |
Returns
Type | Description |
---|---|
EntitySchemaColumn | Колонка, фактически соответствующая метапути |
FindSchemaColumnByPath(String)
Преобразует заданный путь к колонке к фактическому пути с учетом наследования схемы и возвращает соответствующую ему колонку.
Declaration
public virtual EntitySchemaColumn FindSchemaColumnByPath(string columnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке схемы. |
Returns
Type | Description |
---|---|
EntitySchemaColumn | Колонка, фактически соответствующая пути |
FindSchemaColumnPathByMetaPath(String)
По заданному метапути к колонке схемы формирует строку фактического пути к ней, который строится с учетом типа наследования схемы.
Declaration
public string FindSchemaColumnPathByMetaPath(string columnMetaPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnMetaPath | Метапуть к колонке. |
Returns
Type | Description |
---|---|
System.String | Строка фактического пути к колонке, соответствующая метапути |
GenerateMobileBody()
Declaration
[Obsolete("Метод устарел и будет удален")]
public string GenerateMobileBody()
Returns
Type | Description |
---|---|
System.String |
GetDBPrimaryColumn()
Возвращает первичную колонку данной схемы. Если колонка не найдена, генерируется исключение.
Declaration
public EntitySchemaColumn GetDBPrimaryColumn()
Returns
Type | Description |
---|---|
EntitySchemaColumn | Если схема наследуется независимо, будет возвращена первичная колонка текущей схемы. При наследовании схемы один к одному будет возвращена колонка связи с родителем данной схемы. |
GetDBPrimaryColumnName()
Имя первичной колонки данной схемы в таблице базы данных.
Declaration
public string GetDBPrimaryColumnName()
Returns
Type | Description |
---|---|
System.String | Имя колонки в таблице базы данных, соответствующей первичной колонке схемы. |
GetEntitySchemaByKind(EntitySchemaKind)
По заданному типу системной схемы возвращает соответствующий экземпляр системной схемы.
Declaration
public EntitySchema GetEntitySchemaByKind(EntitySchemaKind kind)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaKind | kind | Тип схемы. |
Returns
Type | Description |
---|---|
EntitySchema | Экземпляр EntitySchema типа |
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()
Возвращает суффикс в соответствии с типом текущей схемы, который используется для генерации уникальных имен системных объектов базы данных.
Declaration
public string GetKindSuffix()
Returns
Type | Description |
---|---|
System.String | Суффикс, соответствующий типу текущей схемы. |
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>)
Заполняет переданную коллекцию всеми метаэлементами текущей схемы. MetaItem.
Declaration
public override void GetMetaItems(ICollection<IMetaItem> metaItems)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.ICollection<IMetaItem> | metaItems | Коллекция, которая заполняется метаэлементами текущей схемы. |
Overrides
GetMobileBody()
Declaration
[Obsolete("Метод устарел и будет удален")]
public virtual string GetMobileBody()
Returns
Type | Description |
---|---|
System.String |
GetMultiLookupPathParts(String)
По заданному пути к lookup-колонке схемы формирует массив строк фактических путей к ней, построенных с учетом наследования.
Declaration
public string[] GetMultiLookupPathParts(string columnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке схемы. |
Returns
Type | Description |
---|---|
System.String[] | Массив строк пути к первичной колонке для отображения, преобразованных с учетом наследования. |
GetPrimaryColumnName()
Возвращает имя первичной колонки данной схемы на уровне базы данных.
Declaration
public string GetPrimaryColumnName()
Returns
Type | Description |
---|---|
System.String | Имя первичной колонки схемы. |
GetPrimaryDisplayColumn()
Возвращает первичную колонку для отображения.
Declaration
public EntitySchemaColumn GetPrimaryDisplayColumn()
Returns
Type | Description |
---|---|
EntitySchemaColumn | Первичная колонка для отображения. |
GetPrimaryDisplayColumnName()
Возвращает первичную колонку для отображения. Если такая колонка у схемы не определена, генерируется исключение.
Declaration
public string GetPrimaryDisplayColumnName()
Returns
Type | Description |
---|---|
System.String | Имя первичной колонки для отображения. |
GetResourceManagerName()
Declaration
public override string GetResourceManagerName()
Returns
Type | Description |
---|---|
System.String |
Overrides
GetSchemaColumnByMetaPath(String)
Преобразует заданный метапуть к колонке к фактическому пути с учетом наследования схемы и возвращает соответствующую ему колонку. Если такая колонка не найдена, генерируется исключение.
Declaration
public virtual EntitySchemaColumn GetSchemaColumnByMetaPath(string columnMetaPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnMetaPath | Метапуть к колонке. |
Returns
Type | Description |
---|---|
EntitySchemaColumn | Колонка, фактически соответствующая метапути |
GetSchemaColumnByPath(String)
Преобразует заданный путь к колонке к фактическому пути с учетом наследования схемы и возвращает соответствующую ему колонку. Если такая колонка не найдена, генерируется исключение.
Declaration
public virtual EntitySchemaColumn GetSchemaColumnByPath(string columnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке схемы. |
Returns
Type | Description |
---|---|
EntitySchemaColumn | Колонка, фактически соответствующая пути |
GetSchemaColumnFullCaptionByPath(String, String)
По заданному пути к колонке схемы формирует строку полного заголовка колонки через заданный разделитель.
Declaration
public LocalizableString GetSchemaColumnFullCaptionByPath(string columnPath, string delimiter = ".")
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке схемы. |
System.String | delimiter | Разделитель. |
Returns
Type | Description |
---|---|
LocalizableString | Строка, представляющая собой полный заголовок колонки, заданной в |
GetSchemaColumnMetaPathByPath(String)
По заданному фактическому пути к колонке формирует строку метапути к данной колонке.
Declaration
public string GetSchemaColumnMetaPathByPath(string columnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Фактический путь к колонке. |
Returns
Type | Description |
---|---|
System.String | Метапуть к колонке, заданной |
GetSchemaColumnPathByMetaPath(String)
По заданному метапути к колонке схемы формирует строку фактического пути к ней, который строится с учетом типа наследования схемы.
Declaration
public string GetSchemaColumnPathByMetaPath(string columnMetaPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnMetaPath | Метапуть к колонке. |
Returns
Type | Description |
---|---|
System.String | Строка фактического пути к колонке, соответствующая метапути |
GetSchemaColumnReversePathByPath(String)
По заданному пути к колонке формирует строку фактического пути с обратными связями.
Declaration
public string GetSchemaColumnReversePathByPath(string columnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке схемы. |
Returns
Type | Description |
---|---|
System.String | Путь с обратными связями к колонке схемы, соответствующий |
GetTrackChangesInDBSchema()
Возвращает схему для журналирования текущей схемы.
Declaration
public EntitySchema GetTrackChangesInDBSchema()
Returns
Type | Description |
---|---|
EntitySchema | Экземпляр EntitySchema, отвечающий за журналирование изменений текущей схемы. |
GetTrackChangesInDBSchemaName()
Возвращает имя схемы для журналирования.
Declaration
public string GetTrackChangesInDBSchemaName()
Returns
Type | Description |
---|---|
System.String | Имя схемы для журналирования текущей схемы. |
InitializeColumns()
Инициализация колонок.
Declaration
protected virtual void InitializeColumns()
InitializeColumnsLocalizableValues()
Инициализация локализуемых значений колонок.
Declaration
protected virtual void InitializeColumnsLocalizableValues()
InitializeCreatedByColumn()
Инициализация колонки для хранения ссылки на контакт, который создал запись.
Declaration
protected virtual void InitializeCreatedByColumn()
InitializeCreatedInSchemaUId()
Для наследуемых колонок данной схемы устанавливает уникальный идентификатор схемы, в которой они были созданы.
Declaration
public override void InitializeCreatedInSchemaUId()
Overrides
InitializeCreatedOnColumn()
Инициализация колонки для хранения даты создания.
Declaration
protected virtual void InitializeCreatedOnColumn()
InitializeEventsProcessSchema()
Declaration
protected override void InitializeEventsProcessSchema()
Overrides
InitializeHierarchyColumn()
Инициализация колонки связи с родительской записью для иерархических объектов.
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()
Инициализация индексов.
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()
Инициализация колонки, определяющей, кем была изменения схема.
Declaration
protected virtual void InitializeModifiedByColumn()
InitializeModifiedInSchemaUId()
Для наследуемых колонок данной схемы устанавливает уникальный идентификатор схемы, в которой они были изменены.
Declaration
public override void InitializeModifiedInSchemaUId()
Overrides
InitializeModifiedOnColumn()
Инициализация колонки для хранения даты модификации схемы.
Declaration
protected virtual void InitializeModifiedOnColumn()
InitializeOneToOneParentAssociationColumn()
Инициализация колонки связи с родителем при наследовании один к одному.
Declaration
[Obsolete("7.12.0 | Method is not in use and will be removed in upcoming builds")]
protected virtual void InitializeOneToOneParentAssociationColumn()
InitializeOwnerColumn()
Инициализация колонки владельца записи.
Declaration
protected virtual void InitializeOwnerColumn()
InitializePredefinedColumnsLocalizableValues(Boolean)
Инициализация предопределенных локализуемых значений колонок.
Declaration
protected void InitializePredefinedColumnsLocalizableValues(bool resetCachedValues = false)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | resetCachedValues |
InitializePrimaryColumn()
Инициализация колонки с первичным ключом схемы.
Declaration
protected virtual void InitializePrimaryColumn()
InitializePrimaryDisplayColumn()
Инициализация первичной колонки для отображения данных.
Declaration
protected virtual void InitializePrimaryDisplayColumn()
InitializePrimaryImageColumn()
Инициализация первичной колонки для отображения изображения.
Declaration
protected virtual void InitializePrimaryImageColumn()
InitializePrimaryInfo()
Осуществляет инициализацию основных свойств данной схемы.
Declaration
public override void InitializePrimaryInfo()
Overrides
InitializePrimaryOrderColumn()
Инициализация первичной колонки для сортировки.
Declaration
protected virtual void InitializePrimaryOrderColumn()
InitializeProperties()
Инициализация свойства схемы.
Declaration
protected virtual void InitializeProperties()
InitializeQueries()
Declaration
protected virtual void InitializeQueries()
InitializeRuntimeGeneratedColumns()
Declaration
public virtual void InitializeRuntimeGeneratedColumns()
ReadMetaData(DataReader)
Осуществляет вычитку схемы из метаданных с помощью заданного экземпляра DataReader.
Declaration
public override void ReadMetaData(DataReader reader)
Parameters
Type | Name | Description |
---|---|---|
DataReader | reader | Экземпляр DataReader, с помощью которого вычитываются метаданные схемы. |
Overrides
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)
Всем колонкам, для которых не указана схема, где они были созданы, устанавливает переданный идентификатор схемы.
Declaration
protected void SetColumnsDefInheritance(Guid schemaUId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaUId | Уникальный идентификатор схемы, в которой были созданы колонки. |
SetDefInheritance()
Для всех элементов схемы, у которых не установлен идентификатор родительской схемы, устанавливает идентификатор текущей схемы как родительский.
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 |
|
WriteMetaData(DataWriter)
Осуществляет запись метаданных схемы с помощью заданного экземпляра DataWriter.
Declaration
public override void WriteMetaData(DataWriter writer)
Parameters
Type | Name | Description |
---|---|---|
DataWriter | writer | Экземпляр DataWriter, с помощью которого записываются метаданные схемы. |