Class FlowElement

Represents the element of the business process.

Inheritance
System.Object
FlowElement
FlowCancellationToken
FlowConditionalGateway
FlowIntermediateMessageEvent
FlowParallelGateway
FlowSchema
SequenceFlow
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Terrasoft.Core.Process
Assembly: Terrasoft.Core.dll
Syntax
public class FlowElement : IFlowElement

Constructors

FlowElement()

Declaration
protected FlowElement()

FlowElement(String)

Declaration
protected FlowElement(string bpmnElementName)
Parameters
Type Name Description
System.String bpmnElementName

FlowElement(FlowElement)

Declaration
protected FlowElement(FlowElement flowElement)
Parameters
Type Name Description
FlowElement flowElement

FlowElement(FlowSchema, String)

Initializes a new instance of the FlowElement class.

Declaration
public FlowElement(FlowSchema flowSchema, string bpmnElementName)
Parameters
Type Name Description
FlowSchema flowSchema

The flow schema.
System.String bpmnElementName

Name of the BPMN element.

Properties

BpmnElementName

Gets the BPMN name of the business process item.

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

DataWriterSettings

Declaration
protected JsonDataWriterSettings DataWriterSettings { get; }
Property Value
Type Description
JsonDataWriterSettings

FlowSchema

Returns an instance of the FlowSchema business process schema.

Declaration
public FlowSchema FlowSchema { get; }
Property Value
Type Description
FlowSchema

IsUsedInEventSubProcess

A flag that is used in the event subprocess.

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

Name

Gets and sets the name of the business process item.

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

ParameterPathes

List of ways to values of process parameters.

Declaration
public LinkedList<string> ParameterPathes { get; set; }
Property Value
Type Description
System.Collections.Generic.LinkedList<System.String>

ParameterStore

The storage of the parameters of the IProcessParameterStore business process.

Declaration
public IProcessParameterStore ParameterStore { get; set; }
Property Value
Type Description
IProcessParameterStore

UId

Gets and sets the ID of the business process item.

Declaration
public Guid UId { get; set; }
Property Value
Type Description
System.Guid

Methods

Accept(FlowVisitor, FlowElement)

Process the element of the business process.

Declaration
public virtual void Accept(FlowVisitor visitor, FlowElement previousFlowElement = null)
Parameters
Type Name Description
FlowVisitor visitor

An instance of the FlowVisitor class that is responsible for the transition between the elements of the process.
FlowElement previousFlowElement

Not used.

Clone()

Creates a copy of an instance of a business process item.

Declaration
public virtual FlowElement Clone()
Returns
Type Description
FlowElement

Copy of the FlowElement business process element instance.

Equals(Object)

Determines whether the given FlowElement instance and the specified System.Object instance have the same values.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj

The System.Object instance that is compared to the current FlowElement instance.
Returns
Type Description
System.Boolean

true, if the compared objects are identical; otherwise – false.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Returns a hash code for an entity.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

The hash code for the entity.
Overrides
System.Object.GetHashCode()

ReadProperties(DataReader)

Reads the properties of the business process with the DataReader specified instance.

Declaration
public virtual void ReadProperties(DataReader dataReader)
Parameters
Type Name Description
DataReader dataReader

A class instance for reading properties.

ThrowExceptionObjectNullOrEmpty(String)

Declaration
protected void ThrowExceptionObjectNullOrEmpty(string objectName)
Parameters
Type Name Description
System.String objectName

ToString()

Returns a System.String that represents this instance.

Declaration
public override string ToString()
Returns
Type Description
System.String

A System.String that represents this instance.
Overrides
System.Object.ToString()

WriteProperties(DataWriter)

Writes the properties of the business process with the DataWriter specified instance.

Declaration
public virtual void WriteProperties(DataWriter dataWriter)
Parameters
Type Name Description
DataWriter dataWriter

A class instance for writing properties.

Events

Visited

An event that occurs when an item has been processed.

Declaration
public event Func<FlowElement, IEnumerable<FlowElement>> Visited
Event Type
Type Description
System.Func<FlowElement, System.Collections.Generic.IEnumerable<FlowElement>>

Extension Methods