Class ActivityDefinition

Represent an activity in a process scheme

Inheritance

↳ object

    ↳ BaseDefinition

        ↳ ActivityDefinition

Implements

IInlineActivity

IOrdinaryActivity

Inherited Members

BaseDefinition.Name

BaseDefinition.DesignerSettings

Equals(object)

Equals(object, object)

GetHashCode()

GetType()

MemberwiseClone()

ReferenceEquals(object, object)

ToString()

Namespace: OptimaJet.Workflow.Core.Model

Assembly: OptimaJet.Workflow.Core.dll

Syntax

public class ActivityDefinition : BaseDefinition, IInlineActivity, IOrdinaryActivity

Properties

OriginalName

If object was inlined, you can get its original name from this property

Declaration

public string OriginalName { get; set; }

Property value

Type	Description
string

OriginalSchemeCode

The code of the scheme to which the inlined object originally belonged.

Declaration

public string OriginalSchemeCode { get; set; }

Property value

Type	Description
string

LastTimeInlineName

The name of the inline activity instead of which the object was inlined last time.

Declaration

public string LastTimeInlineName { get; set; }

Property value

Type	Description
string

FirstTimeInlineName

The name of the inline activity instead of which the object was inlined first time.

Declaration

public string FirstTimeInlineName { get; set; }

Property value

Type	Description
string

WasInlined

Return true if the object was inlined.

Declaration

public bool WasInlined { get; set; }

Property value

Type	Description
bool

ActivityType

Type of the activity. Ordinary or Inline.

Declaration

[JsonConverter(typeof(StringEnumConverter))]
public ActivityType ActivityType { get; set; }

Property value

Type	Description
ActivityType

SchemeCode

Inlined scheme name for inline activity.

Declaration

public string SchemeCode { get; set; }

Property value

Type	Description
string

State

Name of the state

Declaration

public string State { get; set; }

Property value

Type	Description
string

IsInitial

If true specifies that the activity is initial. There can be only one initial activity in scheme. Initial activity is the entry point of the process.

Declaration

public bool IsInitial { get; set; }

Property value

Type	Description
bool

IsFinal

If true specifies that the activity is final. The process is marked as finalized after execution of the activity marked as final.

Declaration

public bool IsFinal { get; set; }

Property value

Type	Description
bool

IsForSetState

If true specifies that the activity is entry point for a state and possible to set the state with the ActivityDefinition.State name via OptimaJet.Workflow.Core.Runtime.WorkflowRuntime.SetState(System.Guid%2cSystem.String%2cSystem.String%2cSystem.String%2cSystem.Collections.Generic.IDictionary%7bSystem.String%2cSystem.Object%7d%2cSystem.Boolean) method

Declaration

public bool IsForSetState { get; set; }

Property value

Type	Description
bool

IsAutoSchemeUpdate

If true specifies that if process scheme obsolete than Workflow Runtime will try upgrade it automatically if this activity is current

Declaration

public bool IsAutoSchemeUpdate { get; set; }

Property value

Type	Description
bool

DisablePersistState

If true specifies that the activity is not save state in database (WorkflowProcessInstance)

Declaration

public bool DisablePersistState { get; set; }

Property value

Type	Description
bool

DisablePersistTransitionHistory

If true specifies that the activity is not save state in database (WorkflowProcessTransitionHistory)

Declaration

public bool DisablePersistTransitionHistory { get; set; }

Property value

Type	Description
bool

DisablePersistParameters

If true specifies that the activity is not save state in database (WorkflowProcessInstancePersistence)

Declaration

public bool DisablePersistParameters { get; set; }

Property value

Type	Description
bool

UserComment

Custom comment

Declaration

public string UserComment { get; set; }

Property value

Type	Description
string

HaveImplementation

Specifies that activity have an implementation

Declaration

public bool HaveImplementation { get; }

Property value

Type	Description
bool

HavePreExecutionImplementation

Specifies that activity have a pre-execution implementation

Declaration

public bool HavePreExecutionImplementation { get; }

Property value

Type	Description
bool

Implementation

List of ActionDefinitionReference which are executed at standard workflow execution

Declaration

public List<ActionDefinitionReference> Implementation { get; set; }

Property value

Type	Description
List<ActionDefinitionReference>

PreExecutionImplementation

List of ActionDefinitionReference which are executed at pre-execution

Declaration

public List<ActionDefinitionReference> PreExecutionImplementation { get; set; }

Property value

Type	Description
List<ActionDefinitionReference>

Annotations

A List of Annotation attached to this activity.

Declaration

public List<Annotation> Annotations { get; set; }

Property value

Type	Description
List<Annotation>

ExecutionTimeout

Timeout for execution ActivityTimeout

Declaration

public ActivityTimeout ExecutionTimeout { get; set; }

Property value

Type	Description
ActivityTimeout

IdleTimeout

Timeout for idle ActivityTimeout

Declaration

public ActivityTimeout IdleTimeout { get; set; }

Property value

Type	Description
ActivityTimeout

ExceptionsHandlers

Exceptions handler ActivityExceptionsHandler

Declaration

public List<ActivityExceptionsHandler> ExceptionsHandlers { get; set; }

Property value

Type	Description
List<ActivityExceptionsHandler>

IsState

Specifies that state is assigned

Declaration

public bool IsState { get; }

Property value

Type	Description
bool

NestingLevel

Nesting level of subprocess, 0 - root process, 1-... -subprocesses, null - not assigned

Declaration

public int? NestingLevel { get; set; }

Property value

Type	Description
int?

CustomType

Returns custom type of activity, if the activity is not custom, returns null

Declaration

[JsonIgnore]
public string CustomType { get; set; }

Property value

Type	Description
string

Methods

Create(string, string, string, string, string, string, string, string, string, string)

Create ActivityDefinition object

Declaration

public static ActivityDefinition Create(string name, string stateName, string isInitial, string isFinal, string isForSetState, string isAutoSchemeUpdate, string disablePersist, string disablePersistState, string disablePersistTransitionHistory, string disablePersistParameters)

Parameters

Type	Name	Description
string	name	Name of the activity
string	stateName	Name of the state
string	isInitial	If true specifies that the activity is final. The process is marked as finalized after execution of the activity marked as final.
string	isFinal	If true specifies that the activity is final. The process is marked as finalized after execution of the activity marked as final.
string	isForSetState	If true specifies that the activity is entry point for a state and possible to set the state with the <xref href="OptimaJet.Workflow.Core.Model.ActivityDefinition.State" data-throw-if-not-resolved="false"></xref> name via <xref href="OptimaJet.Workflow.Core.Runtime.WorkflowRuntime.SetState(System.Guid%2cSystem.String%2cSystem.String%2cSystem.String%2cSystem.Collections.Generic.IDictionary%7bSystem.String%2cSystem.Object%7d%2cSystem.Boolean)" data-throw-if-not-resolved="false"></xref> method
string	isAutoSchemeUpdate	If true specifies that if process scheme obsolete than Workflow Runtime will try upgrade it automatically if this activity is current
string	disablePersist	disabling all persist (for old compatibility)
string	disablePersistState	If true specifies that the activity is not save state in database (WorkflowProcessInstance)
string	disablePersistTransitionHistory	If true specifies that the activity is not save state in database (WorkflowProcessTransitionHistory)
string	disablePersistParameters	If true specifies that the activity is not save state in database (WorkflowProcessInstancePersistence)

Returns

Type	Description
ActivityDefinition	ActivityDefinition object

Create(string, string, bool, bool, bool, bool, bool, bool, bool)

Create ActivityDefinition object

Declaration

public static ActivityDefinition Create(string name, string stateName, bool isInitial, bool isFinal, bool isForSetState, bool isAutoSchemeUpdate, bool disablePersistState = false, bool disablePersistTransitionHistory = false, bool disablePersistParameters = false)

Parameters

Type	Name	Description
string	name	Name of the activity
string	stateName	Name of the state
bool	isInitial	If true specifies that the activity is final. The process is marked as finalized after execution of the activity marked as final.
bool	isFinal	If true specifies that the activity is final. The process is marked as finalized after execution of the activity marked as final.
bool	isForSetState	If true specifies that the activity is entry point for a state and possible to set the state with the <xref href="OptimaJet.Workflow.Core.Model.ActivityDefinition.State" data-throw-if-not-resolved="false"></xref> name via <xref href="OptimaJet.Workflow.Core.Runtime.WorkflowRuntime.SetState(System.Guid%2cSystem.String%2cSystem.String%2cSystem.String%2cSystem.Collections.Generic.IDictionary%7bSystem.String%2cSystem.Object%7d%2cSystem.Boolean)" data-throw-if-not-resolved="false"></xref> method
bool	isAutoSchemeUpdate	If true specifies that if process scheme obsolete than Workflow Runtime will try upgrade it automatically if this activity is current
bool	disablePersistState	If true specifies that the activity is not save state in database.
bool	disablePersistTransitionHistory	If true specifies that the activity is not save state in database.
bool	disablePersistParameters	If true specifies that the activity is not save state in database.

Returns

Type	Description
ActivityDefinition	ActivityDefinition object

CreateInlineActivity(string, string)

Creates inline activity

Declaration

public static ActivityDefinition CreateInlineActivity(string name, string schemeCode)

Parameters

Type	Name	Description
string	name
string	schemeCode

Returns

Type	Description
ActivityDefinition

AddAction(ActionDefinitionReference)

Add ActionDefinitionReference to implementation list

Declaration

public void AddAction(ActionDefinitionReference action)

Parameters

Type	Name	Description
ActionDefinitionReference	action	Action reference

AddPreExecutionAction(ActionDefinitionReference)

Add ActionDefinitionReference to pre-execution implementation list

Declaration

public void AddPreExecutionAction(ActionDefinitionReference action)

Parameters

Type	Name	Description
ActionDefinitionReference	action	Action reference

Clone()

Declaration

public ActivityDefinition Clone()

Returns

Type	Description
ActivityDefinition

GetAnnotation<T>(string)

Get an annotation attached to this activity

Declaration

public T GetAnnotation<T>(string name)

Parameters

Type	Name	Description
string	name	Annotation's name

Returns

Type	Description
{T}	Annotation value

GetAnnotation(string)

Get a JSON representation of annotation's value

Declaration

public string GetAnnotation(string name)

Parameters

Type	Name	Description
string	name	Annotation's name

Returns

Type	Description
string	JSON representation of annotation's value

Extension Methods

• Extensions.CastAs<T>(object)
• Extensions.ExtendedEquals(object, object)
• Extensions.TryCast<T>(object, out T)