Class ProcessFlowElement
Represents a process element.
Inheritance
System.Object
ProcessFlowElement
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()
Assembly: Terrasoft.Core.dll
Syntax
public class ProcessFlowElement : IProcessDataSerializable
Constructors
ProcessFlowElement()
Declaration
public ProcessFlowElement()
ProcessFlowElement(UserConnection)
Declaration
public ProcessFlowElement(UserConnection userConnection)
Parameters
Fields
CaptionParameterName
Declaration
protected const string CaptionParameterName = "Caption"
Field Value
Type |
Description |
System.String |
|
CompleteDateParameterName
Declaration
protected const string CompleteDateParameterName = "CompleteDate"
Field Value
Type |
Description |
System.String |
|
CreatedByIdParameterName
Declaration
protected const string CreatedByIdParameterName = "CreatedById"
Field Value
Type |
Description |
System.String |
|
CreatedOnParameterName
Declaration
protected const string CreatedOnParameterName = "CreatedOn"
Field Value
Type |
Description |
System.String |
|
DateTimeTypeName
Declaration
protected const string DateTimeTypeName = "DateTime"
Field Value
Type |
Description |
System.String |
|
DurationInDaysParameterName
Declaration
protected const string DurationInDaysParameterName = "DurationInDays"
Field Value
Type |
Description |
System.String |
|
DurationInHoursParameterName
Declaration
protected const string DurationInHoursParameterName = "DurationInHours"
Field Value
Type |
Description |
System.String |
|
DurationInMillisecondsParameterName
Declaration
protected const string DurationInMillisecondsParameterName = "DurationInMilliseconds"
Field Value
Type |
Description |
System.String |
|
DurationInMinutesParameterName
Declaration
protected const string DurationInMinutesParameterName = "DurationInMinutes"
Field Value
Type |
Description |
System.String |
|
ErrorDescriptionParameterName
Declaration
protected const string ErrorDescriptionParameterName = "ErrorDescription"
Field Value
Type |
Description |
System.String |
|
Float1TypeName
Declaration
protected const string Float1TypeName = "Float1"
Field Value
Type |
Description |
System.String |
|
GuidTypeName
Declaration
protected const string GuidTypeName = "Guid"
Field Value
Type |
Description |
System.String |
|
IdParameterName
Declaration
protected const string IdParameterName = "Id"
Field Value
Type |
Description |
System.String |
|
IntegerTypeName
Declaration
protected const string IntegerTypeName = "Integer"
Field Value
Type |
Description |
System.String |
|
ModifiedByIdParameterName
Declaration
protected const string ModifiedByIdParameterName = "ModifiedById"
Field Value
Type |
Description |
System.String |
|
ModifiedOnParameterName
Declaration
protected const string ModifiedOnParameterName = "ModifiedOn"
Field Value
Type |
Description |
System.String |
|
NamePropertyName
The meta data index for the "Name" property.
Declaration
public const string NamePropertyName = "HK1"
Field Value
Type |
Description |
System.String |
|
NodeIdParameterName
Declaration
protected const string NodeIdParameterName = "NodeId"
Field Value
Type |
Description |
System.String |
|
OwnerIdParameterName
Declaration
protected const string OwnerIdParameterName = "OwnerId"
Field Value
Type |
Description |
System.String |
|
ParentIdParameterName
Declaration
protected const string ParentIdParameterName = "ParentId"
Field Value
Type |
Description |
System.String |
|
PropertiesDataParameterName
Declaration
protected const string PropertiesDataParameterName = "PropertiesData"
Field Value
Type |
Description |
System.String |
|
SchemaElementUIdParameterName
Declaration
protected const string SchemaElementUIdParameterName = "SchemaElementUId"
Field Value
Type |
Description |
System.String |
|
SchemaUIdParameterName
Declaration
protected const string SchemaUIdParameterName = "SchemaUId"
Field Value
Type |
Description |
System.String |
|
StartDateParameterName
Declaration
protected const string StartDateParameterName = "StartDate"
Field Value
Type |
Description |
System.String |
|
StatusIdParameterName
Declaration
protected const string StatusIdParameterName = "StatusId"
Field Value
Type |
Description |
System.String |
|
StatusParameterName
Declaration
protected const string StatusParameterName = "Status"
Field Value
Type |
Description |
System.String |
|
StatusPropertyName
The meta data index for the "Status" property.
Declaration
public const string StatusPropertyName = "HK2"
Field Value
Type |
Description |
System.String |
|
SysProcessIdParameterName
Declaration
protected const string SysProcessIdParameterName = "SysProcessId"
Field Value
Type |
Description |
System.String |
|
SysSchemaIdParameterName
Declaration
protected const string SysSchemaIdParameterName = "SysSchemaId"
Field Value
Type |
Description |
System.String |
|
SysWorkspaceIdParameterName
Declaration
protected const string SysWorkspaceIdParameterName = "SysWorkspaceId"
Field Value
Type |
Description |
System.String |
|
TextTypeName
Declaration
protected const string TextTypeName = "Text"
Field Value
Type |
Description |
System.String |
|
TypeParameterName
Declaration
protected const string TypeParameterName = "Type"
Field Value
Type |
Description |
System.String |
|
UIdPropertyName
The meta data index for the "UId" property.
Declaration
public const string UIdPropertyName = "UId"
Field Value
Type |
Description |
System.String |
|
Properties
Caption
Gets or sets the caption.
Declaration
public virtual string Caption { get; set; }
Property Value
Type |
Description |
System.String |
The caption.
|
CreatedInSchemaUId
Gets or sets unique identifier of the owner process schema where the current element has been created.
Declaration
public virtual Guid CreatedInSchemaUId { get; set; }
Property Value
Type |
Description |
System.Guid |
|
ExecutedEventHandler
Gets or sets event handler. It is triggered when current process element has been executed.
Declaration
public virtual EventHandler<ProcessActivityAfterEventArgs> ExecutedEventHandler { get; set; }
Property Value
ExecutionResult
Gets or sets execution result.
Declaration
public virtual bool ExecutionResult { get; }
Property Value
Type |
Description |
System.Boolean |
|
IsExecuted
Gets or sets value that determines whether the current element has been executed.
Declaration
public virtual bool IsExecuted { get; }
Property Value
Type |
Description |
System.Boolean |
|
IsLogging
Gets or sets value determines whether it is required to log the current element in DB.
Declaration
public virtual bool IsLogging { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
IsProcess
Gets value that determines whether the element is a process.
Declaration
public virtual bool IsProcess { get; }
Property Value
Type |
Description |
System.Boolean |
|
Log
Declaration
protected static ILog Log { get; }
Property Value
Type |
Description |
ILog |
The logger.
|
LoopCounter
Gets or sets number of process element repetitions.
Declaration
public virtual int LoopCounter { get; }
Property Value
Type |
Description |
System.Int32 |
|
Name
Declaration
public virtual string Name { get; set; }
Property Value
Type |
Description |
System.String |
The name.
|
Owner
Gets or sets the owner of the current element.
Declaration
public virtual Process Owner { get; set; }
Property Value
PreviousFlowElements
Gets or sets a set of previous elements of the process.
Declaration
public virtual Collection<string> PreviousFlowElements { get; set; }
Property Value
Type |
Description |
System.Collections.ObjectModel.Collection<System.String> |
|
SchemaElementUId
Gets or sets unique identifier of the schema element.
Declaration
public virtual Guid SchemaElementUId { get; set; }
Property Value
Type |
Description |
System.Guid |
|
SchemaUId
Gets or sets unique identifier of schema element.
Declaration
public virtual Guid SchemaUId { get; set; }
Property Value
Type |
Description |
System.Guid |
|
SerializeToDB
Gets or sets value that determines whether it is required to serialize the current element in DB.
Declaration
public virtual bool SerializeToDB { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
StartDate
Gets or sets date and time of the day when the current process element has been started.
Declaration
public virtual DateTime StartDate { get; set; }
Property Value
Type |
Description |
System.DateTime |
|
Status
Gets or sets the execution state.
Declaration
public virtual ProcessStatus Status { get; set; }
Property Value
Type
Gets or sets the name of the current member type.
Declaration
public virtual string Type { get; set; }
Property Value
Type |
Description |
System.String |
|
UId
Gets or sets the unique identifier.
Declaration
public virtual Guid UId { get; set; }
Property Value
Type |
Description |
System.Guid |
The unique identifier.
|
Methods
ApplyPropertiesDataValues(DataReader)
Applies state of the current process element.
Declaration
protected virtual void ApplyPropertiesDataValues(DataReader reader)
Parameters
Type |
Name |
Description |
DataReader |
reader |
Instance that provides sequential reading of data.
|
Assign(ProcessFlowElement)
Assigns the property values of the current process element to the properties of the specified element.
Declaration
protected virtual void Assign(ProcessFlowElement processElement)
Parameters
CloneShallow()
Creates a shallow copy of the current process element.
Declaration
public virtual object CloneShallow()
Returns
Type |
Description |
System.Object |
Instance that is a copy of the current process element.
|
CompleteApplyingPropertiesDataValues()
Declaration
protected virtual void CompleteApplyingPropertiesDataValues()
Execute(ProcessExecutingContext)
Executes current flow element.
Declaration
public virtual bool Execute(ProcessExecutingContext context)
Parameters
Returns
Type |
Description |
System.Boolean |
true , if element was successfully executed and conditions for moving to the next step were
satisfied. Otherwise - false .
|
GetPropertiesData()
Returns serialized state of the current process element.
Declaration
public virtual string GetPropertiesData()
Returns
Type |
Description |
System.String |
String that represents serialized state of the current process element.
|
GetPropertiesData(Boolean)
Returns serialized state of the current process element.
Declaration
public virtual string GetPropertiesData(bool shouldWriteElements)
Parameters
Type |
Name |
Description |
System.Boolean |
shouldWriteElements |
Indicates whether to write other process elements.
|
Returns
Type |
Description |
System.String |
String that represents serialized state of the current process element.
|
GetSchemaElement(Guid)
Returns owner schema element by the specified identifier.
Declaration
protected BaseProcessSchemaElement GetSchemaElement(Guid schemaElementUId)
Parameters
Type |
Name |
Description |
System.Guid |
schemaElementUId |
Schema element identifier.
|
Returns
InternalExecute(ProcessExecutingContext)
Declaration
protected virtual bool InternalExecute(ProcessExecutingContext context)
Parameters
Returns
Type |
Description |
System.Boolean |
|
OnExecuted(ProcessActivityAfterEventArgs)
This method is called after the current process element is executed.
Declaration
protected virtual void OnExecuted(ProcessActivityAfterEventArgs e)
Parameters
ReadPropertiesData()
Declaration
public virtual void ReadPropertiesData()
ReadPropertiesData(DataReader)
Reads state of the current process element.
Declaration
public virtual void ReadPropertiesData(DataReader reader)
Parameters
Type |
Name |
Description |
DataReader |
reader |
Instance that provides sequential reading of data.
|
ReadPropertiesDataFromOwner(DataReader)
Reads the properties data from owner process data stream.
Declaration
public virtual void ReadPropertiesDataFromOwner(DataReader dataReader)
Parameters
Type |
Name |
Description |
DataReader |
dataReader |
The data reader.
|
ReadSerializableObjectValue(DataReader)
Declaration
protected virtual object ReadSerializableObjectValue(DataReader reader)
Parameters
Type |
Name |
Description |
DataReader |
reader |
|
Returns
Type |
Description |
System.Object |
|
SetDurationQueryParameters(QueryParameterCollection)
Sets value of the duration query parameter.
Declaration
[Obsolete("7.16.1 | Method is not in use and will be removed in upcoming releases")]
protected void SetDurationQueryParameters(QueryParameterCollection parameters)
Parameters
SetPrivateFieldValue(String, Object, Object)
Sets the value of private field of a process instance.
Declaration
protected virtual void SetPrivateFieldValue(string fieldName, object source, object value)
Parameters
Type |
Name |
Description |
System.String |
fieldName |
Field name that is declared in the "source" argument.
|
System.Object |
source |
Instance of the Process type.
|
System.Object |
value |
The new field value.
|
ToString()
Declaration
public override string ToString()
Returns
Type |
Description |
System.String |
|
Overrides
System.Object.ToString()
Attempts to get performer user.
Declaration
public virtual bool TryGetPerformer(out Guid performerUId)
Parameters
Type |
Name |
Description |
System.Guid |
performerUId |
Unique identifier of the performer user.
|
Returns
Type |
Description |
System.Boolean |
true if current performer is defined; otherwisefalse .
|
WritePropertiesData()
Declaration
public virtual void WritePropertiesData()
WritePropertiesData(DataWriter)
Writes state of the current process element.
Declaration
public virtual void WritePropertiesData(DataWriter writer)
Parameters
Type |
Name |
Description |
DataWriter |
writer |
Instance of the type.
|
WritePropertiesData(DataWriter, Boolean)
Writes state of the current process element.
Declaration
public virtual void WritePropertiesData(DataWriter writer, bool shouldWriteElements)
Parameters
Type |
Name |
Description |
DataWriter |
writer |
Instance of the type.
|
System.Boolean |
shouldWriteElements |
Indicates whether to write other process elements.
|
WritePropertiesDataToDB(UserConnection)
Writes state of the current process element to DB.
Declaration
public virtual void WritePropertiesDataToDB(UserConnection userConnection)
Parameters
WritePropertiesDataToOwner(DataWriter)
Writes the properties data to owner process data stream.
Declaration
public virtual void WritePropertiesDataToOwner(DataWriter writer)
Parameters
Type |
Name |
Description |
DataWriter |
writer |
The data writer.
|
WritePropertyValues(DataWriter)
Declaration
protected virtual void WritePropertyValues(DataWriter writer)
Parameters
Type |
Name |
Description |
DataWriter |
writer |
|
Events
Executed
Occurs when the Execute method is called in the process element.
Declaration
public event EventHandler<ProcessActivityAfterEventArgs> Executed
Event Type
Implements
Extension Methods