Class EmbeddedProcess
Represents class of the embedded process.
Implements
Inherited Members
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
public abstract class EmbeddedProcess : Process, IProcessDataSerializable, IHandler<ChangeProcessElementPerformerCommand>
Constructors
EmbeddedProcess(UserConnection)
Initializes a new instance of the Process class.
Declaration
protected EmbeddedProcess(UserConnection userConnection)
Parameters
| Type | Name | Description |
|---|---|---|
| UserConnection | userConnection | The user connection. |
Properties
IsEmbedded
Declaration
public override bool IsEmbedded { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
IsLogging
Declaration
public override bool IsLogging { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
SerializeToDB
Declaration
public override bool SerializeToDB { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
SerializeToMemory
Declaration
public override bool SerializeToMemory { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
Methods
CompleteProcess()
Completes execution of the current process.
Declaration
protected override bool CompleteProcess()
Returns
| Type | Description |
|---|---|
| System.Boolean | True if completed, otherwise throws exception. |
Overrides
Exceptions
| Type | Condition |
|---|---|
| ItemNotFoundException | If the running process is not found. |
Execute(UserConnection)
Executes the current process.
Declaration
public override bool Execute(UserConnection userConnection)
Parameters
| Type | Name | Description |
|---|---|---|
| UserConnection | userConnection | User connection. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
GetPropertiesData(Boolean)
Returns serialized state of the current process.
Declaration
public override string GetPropertiesData(bool writeFlowElements = true)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | writeFlowElements |
Returns
| Type | Description |
|---|---|
| System.String | String that represents serialized state of the current process element. |
Overrides
GetSchema(Guid)
Declaration
protected override Schema GetSchema(Guid schemaUId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | schemaUId |
Returns
| Type | Description |
|---|---|
| Schema |
Overrides
InternalExecute(ProcessExecutingContext)
Declaration
protected override bool InternalExecute(ProcessExecutingContext context)
Parameters
| Type | Name | Description |
|---|---|---|
| ProcessExecutingContext | context |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
ProcessQueue(ProcessExecutingContext)
Method does nothing.
Declaration
protected override bool ProcessQueue(ProcessExecutingContext context)
Parameters
| Type | Name | Description |
|---|---|---|
| ProcessExecutingContext | context | Process executing context. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns |
Overrides
ReadPropertiesData()
Reads state of the current process.
Declaration
public override void ReadPropertiesData()
Overrides
ReadPropertiesDataFromDB(UserConnection)
Reads state of the current process from DB.
Declaration
public override void ReadPropertiesDataFromDB(UserConnection userConnection)
Parameters
| Type | Name | Description |
|---|---|---|
| UserConnection | userConnection | User connection. |
Overrides
ShouldWriteFlowElementProperties(ProcessFlowElement)
Declaration
protected override bool ShouldWriteFlowElementProperties(ProcessFlowElement flowElement)
Parameters
| Type | Name | Description |
|---|---|---|
| ProcessFlowElement | flowElement |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
WriteFlowElementsProperty(DataWriter)
Declaration
protected override void WriteFlowElementsProperty(DataWriter writer)
Parameters
| Type | Name | Description |
|---|---|---|
| DataWriter | writer |
Overrides
WritePropertiesData()
Writes state of the current process.
Declaration
public override void WritePropertiesData()
Overrides
WritePropertiesDataToDB(UserConnection)
Writes state of the current process to DB.
Declaration
public override void WritePropertiesDataToDB(UserConnection userConnection)
Parameters
| Type | Name | Description |
|---|---|---|
| UserConnection | userConnection | User connection. |