Platform Core .NET Assemblies API
EntitySchema Class Members
See Also  Properties  Methods  Send Feedback
Terrasoft.Core.Entities Namespace : EntitySchema Class

Glossary Item Box

The following tables list the members exposed by EntitySchema.

Public Constructors

 NameDescription
Public ConstructorEntitySchema ConstructorOverloaded.   
Top

Public Properties

 NameDescription
Public PropertyAdministratedByColumnsIndicates that the schema is managed by columns.  
Public PropertyAdministratedByOperationsIndicates that the schema is managed by operations.  
Public PropertyAdministratedByRecordsIndicates that the schema is managed by records.  
Public PropertyAdministratedByRecordsIncludeParents  
Public PropertyAutoInitializeColumnsIndication of automatic initialization of columns.  
Public Propertystatic (Shared in Visual Basic)BaseSchemaUIdBase schema unique identifier.  
Public PropertyColumnsCollection of schema columns.  
Public PropertyCreatedByColumnColumn for storing reference to contact that created the record.  
Public PropertyCreatedOnColumnColumn for storing the record creation date.  
Public PropertyDataValueTypeManagerData type manager for schema columns.  
Public PropertyDesignLocalizationSchemaNameLocalization schema name in design time.  
Public PropertyEntitySchemaManagerEntity schema manager.  
Public PropertyEventsSchema events.  
Public PropertyHasEventsIndication of events for the given schema.  
Public PropertyHasIndependentProcessListenersIndicates that the schema has its own finished conditions for the process items that differ from the system conditions.  
Public PropertyHierarchyColumnColumn of the parent record relationship for hierarchical entities. Used to create hierarchical queries.  
Public PropertyIndexesCollection of schema indexes.  
Public PropertyIsDBViewIndicates whether the schema is a view in the database.  
Public PropertyIsDynamicallyCreatedIndicates that the schema is dynamically created.  
Public PropertyIsLocalizableIndicates whether schema is localizable.  
Public PropertyIsTrackChangesInDBIndication whether the schema is logged or not.  
Public PropertyIsVirtualIndication of the virtual schema.  
Public PropertyKindSchema type.  
Public PropertyLocalizationSchemaNameLocalization schema name.  
Public PropertyManagerOverridden. Schema manager.  
Public PropertyMasterRecordColumnMaster record entity column. If it is set, and the current entity is not administrated by records, then record rights from master record will be applied. If an entity is administrated by master record permissions, empty master record column considered as empty permissions. If an entity is administrated by records and by master records, the master record permissions are not applied. Only lookup columns can be used for this property, required on application level preferably.  
Public PropertyMasterRecordSchemaNameMaster record entity schema name.  
Public PropertyModifiedByColumnColumn for storing reference to contact that modified the record.  
Public PropertyModifiedOnColumnColumn for storing the record modified date.  
Public PropertyOwnerColumnColumn indicating an owner. Used to assign write access rights to owner.  
Public PropertyParentSchemaParent schema.  
Public PropertyParentSchemaUIdUnique identifier of the parent schema.  
Public PropertyPrimaryColumnColumn that represents the primary key.  
Public PropertyPrimaryDisplayColumnPrimary data display column.  
Public PropertyPrimaryImageColumnPrimary image display column.  
Public PropertyPrimaryOrderColumnPrimary sorting column.  
Public PropertyProcessSchemaManagerOverridden. Process schema manager.  
Public PropertyRightSchemaName  
Public PropertySystemEntitySchemaManagerManager of system entity schemas.  
Public Propertystatic (Shared in Visual Basic)SystemNameAdditionalLength  
Public PropertySystemValueManagerSystem input manager.  
Public PropertyTrackChangesInDBEntitySchema  
Public PropertyTrackChangesSchemaName  
Public PropertyUIdOverridden. Unique identifier.  
Public PropertyUseDenyRecordRightsIndicates that the denied access rights are used for the schema.  
Public PropertyUseMasterRecordRightsIndicates whether current entity uses master record rights.  
Public PropertyUseRecordDeactivationIndicates whether schema should use disabling records.  
Top

Public Methods

 NameDescription
Public MethodAddColumnOverloaded.   
Public MethodAddLookupColumnOverloaded.   
Public MethodAddSystemLookupColumnAdds a new column of the lookup type with using the column name and name of the system lookup schema.  
Public MethodAssignParentSchemaSets the specified schema as parent.  
Public MethodCloneOverridden. Gets the System.Object instance that is a clone of the current schema.  
Public MethodCloneShallowGets the EntitySchema instance that is a clone of the current schema without columns.  
Public MethodCreateColumnMap  
Public MethodCreateEntityCreates the instance of the entity described by the schema.  
Public MethodCreateEventsProcessOverridden.   
Public MethodCreateGeneralSelectReturns 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.  
Public MethodCreateSelectOverloaded.   
Public MethodCreateTrackChangesInsertSelectReturns the request to save a record to the change log if the it is kept for the schema.  
Public MethodFindPrimaryDisplayColumnNameDetermines whether the current schema contains a primary display column.  
Public MethodFindSchemaColumnByMetaPathConverts the specified meta path to column into actual path, while accounting for type of inheritance, and returns the matched column to it.  
Public MethodFindSchemaColumnByPathConverts the specified path to column into actual path, while accounting for type of inheritance, and returns the matched column to it.  
Public MethodFindSchemaColumnPathByMetaPathBy the specified meta path to the schema column, generates the string of actual path that is built based on the type of inheritance.  
Public MethodGetDBPrimaryColumnReturns the primary column for the current schema. If the column is not found, the exception is thrown.  
Public MethodGetDBPrimaryColumnNameName of the primary column of the given schema in the database table.  
Public MethodGetEntitySchemaByKindGets the schema instance matching the specified type of the system schema.  
Public MethodGetFirstSchemaColumnNameByPath  
Public MethodGetInactiveColumnReturns RecordDisabled column instance.  
Public MethodGetKindSuffixGets the suffix associated with the type of the current schema that is used for generating unique names of database system entities.  
Public MethodGetLocalizableValuesOverloaded. Overridden.   
Public MethodGetLocalizationSchemaReturns localization schema for current schema.  
Public MethodGetMetaItemsOverridden. Fills the passed collection with all the meta-elements of the current schema. Terrasoft.Core.MetaItem.  
Public MethodGetMultiLookupPathPartsFrom the specified path to lookup column of the schema, generates the array of actual path strings that are built, while accounting for inheritance.  
Public MethodGetPrimaryColumnNameReturns the name of the primary column of the given schema at the database level.  
Public MethodGetPrimaryDisplayColumnReturns the primary display column.  
Public MethodGetPrimaryDisplayColumnNameReturns the primary display column. If the same column is not specified for the schema, the exception is thrown.  
Public MethodGetResourceManagerNameOverridden.   
Public MethodGetSchemaColumnByMetaPathConverts 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.  
Public MethodGetSchemaColumnByPathConverts 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.  
Public MethodGetSchemaColumnFullCaptionByPathFrom the specified path to column generates the full caption of column, using the specified delimiter.  
Public MethodGetSchemaColumnMetaPathByPathFrom the specified actual path to column generates the string of meta path to this column.  
Public MethodGetSchemaColumnPathByMetaPathBy the specified meta path to the schema column, generates the string of actual path that is built based on the type of inheritance.  
Public MethodGetSchemaColumnReversePathByPathFrom the specified path to column generates the actual path string with inverse associations.  
Public MethodGetTrackChangesInDBSchemaReturns schema for logging the current schema.  
Public MethodGetTrackChangesInDBSchemaNameReturns the schema name for logging.  
Public MethodInitializeCreatedInSchemaUIdOverridden. For the inherited columns of the given schema sets the unique identifier of the schema in which these columns have been created.  
Public MethodInitializeLocalizableValuesOverloaded.   
Public MethodInitializeModifiedInSchemaUIdOverridden. For the inherited columns of the given schema sets the unique identifier of the schema in which these columns have been modified.  
Public MethodInitializePrimaryInfoOverridden. Initializes primary properties of the given schema.  
Public MethodInitializeRuntimeGeneratedColumns  
Public MethodReadMetaDataOverridden. Reads the schema from metadata, using the specified Terrasoft.Common.DataReader instance.  
Public MethodReInitializeLocalizableValuesOverridden. Performs reinitialization of localizable values from specified group resourceGroupName in resourceManagerName resource manager.  
Public MethodSetDefInheritanceOverridden. Sets the current schema identifier as the parent for all schema elements that do not have a parent schema identifier.  
Public MethodValidateNamesChecks current schema and its elements validity.  
Public MethodWriteMetaDataOverridden. Records schema metadata using the Terrasoft.Common.DataWriter instance.  
Top

See Also

© Terrasoft 2002-2018.