Class ProcessBasedSchema
Base class of the schema that contains an embedded process.
Inherited Members
Namespace: Terrasoft.Core.Process
Assembly: Terrasoft.Core.dll
Syntax
[DesignModeProperty(Name = "EventsProcessSchema", UsageType = DesignModeUsageType.None, MetaPropertyName = "EG1")]
public abstract class ProcessBasedSchema : Schema, IMetaDataSerializable, ICloneable, IMetaSchema, IMetaItem, IManagerItemInstance
Constructors
ProcessBasedSchema(ISchemaManager)
Initializes a new ProcessBasedSchema instance with the specified schema manager.
Declaration
protected ProcessBasedSchema(ISchemaManager schemaManager)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManager | schemaManager | Schema manager. |
ProcessBasedSchema(ProcessBasedSchema)
Initializes a new ProcessBasedSchema instance that is a clone of the specified schema.
Declaration
protected ProcessBasedSchema(ProcessBasedSchema source)
Parameters
Type | Name | Description |
---|---|---|
ProcessBasedSchema | source | Schema whose clone is being created. |
Fields
_isInitializedEventsProcessSchemaLocalizableValues
Declaration
protected bool _isInitializedEventsProcessSchemaLocalizableValues
Field Value
Type | Description |
---|---|
System.Boolean |
_parentProcessBasedSchema
Declaration
protected Lazy<ProcessBasedSchema> _parentProcessBasedSchema
Field Value
Type | Description |
---|---|
System.Lazy<ProcessBasedSchema> |
_resourceGroupName
Declaration
protected string _resourceGroupName
Field Value
Type | Description |
---|---|
System.String |
_resourceManagerName
Declaration
protected string _resourceManagerName
Field Value
Type | Description |
---|---|
System.String |
EventsProcessPartName
Declaration
public const string EventsProcessPartName = "EventsProcess"
Field Value
Type | Description |
---|---|
System.String |
Properties
EventsProcessSchema
The embedded process schema.
Declaration
public ProcessSchema EventsProcessSchema { get; set; }
Property Value
Type | Description |
---|---|
ProcessSchema |
IsEventsProcessSchemaInitialized
Determines whether the schema of the embedded process of the current schema is initialized.
Declaration
protected bool IsEventsProcessSchemaInitialized { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ParentProcessBasedSchema
Parent schema.
Declaration
public ProcessBasedSchema ParentProcessBasedSchema { get; }
Property Value
Type | Description |
---|---|
ProcessBasedSchema |
ProcessSchemaManager
Manager of schema that contains an embedded process.
Declaration
public abstract ProcessSchemaManager ProcessSchemaManager { get; }
Property Value
Type | Description |
---|---|
ProcessSchemaManager |
Methods
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
CreateEventsProcess(UserConnection)
Creates an instance of the embedded process of the schema.
Declaration
public virtual EmbeddedProcess CreateEventsProcess(UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | User connection. |
Returns
Type | Description |
---|---|
EmbeddedProcess | Instance of the created embedded process. |
Exceptions
Type | Condition |
---|---|
System.NotImplementedException | Virtual method is not implemented in the ProcessBasedSchema class, and it is overridden by the ProcessBasedSchema inheritors. |
GetMetaItems(ICollection<IMetaItem>)
Fills the passed collection with meta items of the current schema.
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
GetSchemaReferences()
Gets a collection of references to assemblies that are required to compile the schema.
Declaration
public override CodeCompilerReferenceCollection GetSchemaReferences()
Returns
Type | Description |
---|---|
CodeCompilerReferenceCollection | Collection of references to the assembly that are needed to compile the schema. |
Overrides
InitializeEventsProcessSchema()
Initializes the embedded process schema.
Declaration
protected abstract void InitializeEventsProcessSchema()
InitializeEventsProcessSchemaLocalizableValues()
Initializes the localizable values of the embedded process of the schema.
Declaration
public void InitializeEventsProcessSchemaLocalizableValues()
InitializeLocalizableValues(String, String)
Initializes the localizable values of the schema with the embedded process from the specified group of the given 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
ReInitializeLocalizableValues(String, String)
Declaration
public override void ReInitializeLocalizableValues(string resourceManagerName, string resourceGroupName = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | resourceManagerName | |
System.String | resourceGroupName |
Overrides
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. |