Class BaseProcessSchema

Represents base class for the process diagram.

Inheritance
System.Object
MetaItem
MetaSchema
Schema
BaseProcessUserTaskSchema
BaseProcessSchema
CampaignSchema
DcmSchema
ProcessSchema
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.Process
Assembly: Terrasoft.Core.dll
Syntax
[MetaType("B3761B78-3CC7-46FC-9E3D-93489ADACD27")]
[DesignModeGroup(Name = "General", Position = 1)]
[DesignModeGroup(Name = "Behaviour", Position = 5)]
[DesignModeProperty(Name = "IsValid", UsageType = DesignModeUsageType.NotVisible, MetaPropertyName = "IJ6")]
[DesignModeProperty(Name = "ParentSchemaUId", Group = "General", Position = 2, ValuesProvider = "ProcessSchemaManagerUIdValuesProvider", UsageType = DesignModeUsageType.None, MetaPropertyName = "BK8")]
[DesignModeProperty(Name = "Mappings", UsageType = DesignModeUsageType.None, MetaPropertyName = "BK15")]
[DesignModeProperty(Name = "Version", Group = "General", Position = 9, DefValue = 0, IsReadOnly = true, UsageType = DesignModeUsageType.General | DesignModeUsageType.Advanced | DesignModeUsageType.NotVisible | DesignModeUsageType.Available | DesignModeUsageType.NuiDesigner, MetaPropertyName = "IJ9")]
[DesignModeProperty(Name = "EntitySchemaUId", MetaPropertyName = "EntitySchemaUId", UsageType = DesignModeUsageType.NotVisible)]
[DesignModeProperty(Name = "NotificationCaption", Group = "General", UsageType = DesignModeUsageType.General | DesignModeUsageType.Advanced | DesignModeUsageType.NotVisible | DesignModeUsageType.Available | DesignModeUsageType.NuiDesigner, MetaPropertyName = "BK37")]
[DesignModeProperty(Name = "UseSystemSecurityContext", UsageType = DesignModeUsageType.General | DesignModeUsageType.Advanced | DesignModeUsageType.NotVisible | DesignModeUsageType.Available | DesignModeUsageType.NuiDesigner, MetaPropertyName = "IJ10", Group = "Behaviour")]
[DesignModeProperty(Name = "StudioFreeProcessUrl", UsageType = DesignModeUsageType.General | DesignModeUsageType.Advanced | DesignModeUsageType.NotVisible | DesignModeUsageType.Available | DesignModeUsageType.NuiDesigner, MetaPropertyName = "IJ11", Group = "Behaviour")]
[DesignModeProperty(Name = "BackgroundModePriority", UsageType = DesignModeUsageType.General | DesignModeUsageType.Advanced | DesignModeUsageType.NotVisible | DesignModeUsageType.Available | DesignModeUsageType.NuiDesigner, MetaPropertyName = "IJ12", Group = "General")]
public abstract class BaseProcessSchema : BaseProcessUserTaskSchema, IMetaDataSerializable, ICloneable, IMetaSchema, IManagerItemInstance, IParametrizedProcessSchemaElement, IProcessElementMetaInfo, IProcessParametersMetaInfo, IMetaItem

Constructors

BaseProcessSchema(ISchemaManager)

Creates a new instance with specified schema manager.

Declaration
protected BaseProcessSchema(ISchemaManager schemaManager)
Parameters
Type Name Description
ISchemaManager schemaManager

Instance that implements the ISchemaManager interface.

BaseProcessSchema(BaseProcessSchema)

Creates a new instance that is a copy of another instance.

Declaration
protected BaseProcessSchema(BaseProcessSchema source)
Parameters
Type Name Description
BaseProcessSchema source

Instance that inherited the BaseProcessSchema type.

Fields

IsActiveVersionName

The meta data index for the "IsActiveVersion" property.

Declaration
protected const string IsActiveVersionName = "IJ7"
Field Value
Type Description
System.String

IsDeliveredName

The meta data index for the "IsDelivered" property.

Declaration
protected const string IsDeliveredName = "IJ8"
Field Value
Type Description
System.String

IsLoggingPropertyName

The meta data index for the "IsLogging" property.

Declaration
protected const string IsLoggingPropertyName = "IJ3"
Field Value
Type Description
System.String

MaxLoopCountPropertyName

The meta data index for the "MaxLoopCount" property.

Declaration
protected const string MaxLoopCountPropertyName = "IJ2"
Field Value
Type Description
System.String

SerializeToDBPropertyName

The meta data index for the "SerializeToDB" property.

Declaration
protected const string SerializeToDBPropertyName = "IJ1"
Field Value
Type Description
System.String

SerializeToMemoryPropertyName

The meta data index for the "SerializeToMemory" property.

Declaration
protected const string SerializeToMemoryPropertyName = "IJ4"
Field Value
Type Description
System.String

StudioFreeProcessUrlName

The meta data index for the "StudioFreeProcessUrl" property.

Declaration
protected const string StudioFreeProcessUrlName = "IJ11"
Field Value
Type Description
System.String

VersionName

The meta data index for the "Version" property.

Declaration
protected const string VersionName = "IJ9"
Field Value
Type Description
System.String

Properties

BackgroundModePriority

Gets or sets process elements execution priority in background mode.

Declaration
[MetaTypeProperty("{A22D74C5-8D21-4A2C-8581-3961E2FD6C15}")]
public virtual BackgroundModePriority BackgroundModePriority { get; set; }
Property Value
Type Description
BackgroundModePriority

BpmnElementName

Returns the name of the business process element BPMN.

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

EntitySchemaUId

Gets entity schema identifier.

Declaration
[MetaTypeProperty("{8FCA55CF-135F-4177-8A62-58E50B69D629}")]
public virtual Guid EntitySchemaUId { get; set; }
Property Value
Type Description
System.Guid

ExecutionTracePoints

Value that indicates whether is needed

Declaration
[MetaTypeProperty("{7072DFFF-CB19-45B8-BB23-33AA06E660FB}", IsUserProperty = true, DefValue = ExecutionTracePoints.None)]
public ExecutionTracePoints ExecutionTracePoints { get; set; }
Property Value
Type Description
ExecutionTracePoints

IsActiveVersion

Gets the value indicating whether this schema is active.

Declaration
[MetaTypeProperty("F51344A7-56E3-4161-9D6F-81EFD2ADF61F", IsUserProperty = true, IsExtraProperty = true, DefValue = true, UserPropertyNullValue = false)]
public bool IsActiveVersion { get; set; }
Property Value
Type Description
System.Boolean

IsDelivered

Gets the value indicating whether this schema is delivered.

Declaration
[MetaTypeProperty("76BBA8BC-F795-4D47-8B73-1C8A26E73562")]
public bool IsDelivered { get; set; }
Property Value
Type Description
System.Boolean

IsInterpretable

Gets or sets flag that indicates whether the process can be interpreted.

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

IsLogging

Gets or sets flag that indicates whether the process needs to be logged.

Declaration
[MetaTypeProperty("{D36B8FEC-AA6B-4D75-80CF-7707FA136738}", DefValue = true)]
public virtual bool IsLogging { get; set; }
Property Value
Type Description
System.Boolean

IsTracing

Process is in tracing mode.

Declaration
[MetaTypeProperty("{8A206382-FCAF-46DC-B86B-825679BD194F}", IsExtraProperty = true, IsUserProperty = true, DefValue = false)]
public bool IsTracing { get; set; }
Property Value
Type Description
System.Boolean

IsValid

Flag determines whether the current schema is valid.

Declaration
[MetaTypeProperty("{0F1CD390-EB61-4356-ABDF-D07440CAAFD4}", DefValue = true)]
public bool IsValid { get; set; }
Property Value
Type Description
System.Boolean

Manager

Gets instance that implements the IManager interface.

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

Mappings

Declaration
[MetaTypeProperty("{987A4561-39F0-41CE-8902-0436B24FD235}")]
public ProcessSchemaMappingCollection Mappings { get; }
Property Value
Type Description
ProcessSchemaMappingCollection

MaxLoopCount

Declaration
[MetaTypeProperty("{B415CEDD-AC3D-4662-885D-DDAE2F66FC45}")]
public int MaxLoopCount { get; set; }
Property Value
Type Description
System.Int32

NotificationCaption

Get schema parameter that represents the caption of process notification.

Declaration
[MetaTypeProperty("{FED6E771-EB47-4631-8F7E-B65C98D4D358}")]
public ProcessSchemaParameter NotificationCaption { get; }
Property Value
Type Description
ProcessSchemaParameter

ParentSchemaUId

Gets or sets UId of the parent schema.

Declaration
[MetaTypeProperty("{55B80074-4A72-4657-B3A6-DFDC457CDF94}")]
public virtual Guid ParentSchemaUId { get; set; }
Property Value
Type Description
System.Guid

SerializeToDB

Gets or sets flag that indicates whether the process needs to be serialized to DB.

Declaration
[MetaTypeProperty("{7D05705B-8916-4A37-AFB4-EF4E609C0FA5}")]
public virtual bool SerializeToDB { get; set; }
Property Value
Type Description
System.Boolean

SerializeToMemory

Gets or sets flag that indicates whether the process needs to be serialized to memory.

Declaration
[MetaTypeProperty("{D11A34E5-362F-457B-B146-ECADA3E21295}")]
public virtual bool SerializeToMemory { get; set; }
Property Value
Type Description
System.Boolean

StudioFreeProcessUrl

Studio Free Process URL.

Declaration
[MetaTypeProperty("{88A23812-36D9-4F84-B194-BE813F2DDB24}", IsExtraProperty = true, DefValue = "")]
public string StudioFreeProcessUrl { get; set; }
Property Value
Type Description
System.String

UseSystemSecurityContext

Gets or sets value that indicates whether is needed system security context.

Declaration
[MetaTypeProperty("{340E7E2A-D591-4980-A1AA-93FA8B7B3400}", DefValue = false)]
public virtual bool UseSystemSecurityContext { get; set; }
Property Value
Type Description
System.Boolean

Version

Gets or sets the version number of the current schema.

Declaration
[MetaTypeProperty("{0CA3B659-4C55-475D-874E-BDA6EBB3E77D}", DefValue = 0, IsExtraProperty = true)]
public int Version { get; set; }
Property Value
Type Description
System.Int32

Methods

ApplyMetaDataValue(DataReader)

Applies meta data values.

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

Instance of the DataReader type.
Overrides

CheckSchemaHasInvalidElements()

Checks whether the current schema has invalid elements.

Declaration
protected virtual void CheckSchemaHasInvalidElements()

CompleteApplyingMetaDataValues()

Loads resources and synchronizes elements parameters. Called at the end of meta data initialization.

Declaration
protected override void CompleteApplyingMetaDataValues()
Overrides

CreateProcess(UserConnection)

Creates new process instance for current schema.

Declaration
public virtual Process CreateProcess(UserConnection userConnection)
Parameters
Type Name Description
UserConnection userConnection

The user connection.
Returns
Type Description
Process

Process instance.

ForceGetParameters()

Forcibly obtains process parameters.

Declaration
public ProcessSchemaParameterCollection ForceGetParameters()
Returns
Type Description
ProcessSchemaParameterCollection

Collection of process parameters.

GetLocalizableValues(ICollection<LocalizableValue>, Boolean)

Gets localized schema values.

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

Localized values.
System.Boolean shouldIncludeInherited

Determines whether should get inherited values.
Overrides

InitializeLocalizableValues(String, String)

Initializes of localized schema values.

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

Name of the resource manager.
System.String resourceGroupName

Name of the resource group.
Overrides

LoadLocalizableValues()

Loads localized schema values.

Declaration
public override void LoadLocalizableValues()
Overrides

LoadResources()

Loads schema resources.

Declaration
protected virtual void LoadResources()

SynchronizeParameters()

Synchronizes elements parameters.

Declaration
public abstract void SynchronizeParameters()

WriteMetaData(DataWriter)

Writes meta data values.

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

Instance of the DataWriter type.
Overrides

Implements

System.ICloneable

Extension Methods