Class TransitionDefinition

Represent a transition in a process scheme

Inheritance

↳ object

    ↳ BaseDefinition

        ↳ TransitionDefinition

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 TransitionDefinition : BaseDefinition

Properties

InlinedFinalActivityName

Final activity name in inlined scheme, may not be filled, then any final activity from inlined scheme will be taken

Declaration

public string InlinedFinalActivityName { get; set; }

Property value

Type	Description
string

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

UserComment

Custom comment

Declaration

public string UserComment { 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

From

Source activity

Declaration

public ActivityDefinition From { get; set; }

Property value

Type	Description
ActivityDefinition

To

Destination activity

Declaration

public ActivityDefinition To { get; set; }

Property value

Type	Description
ActivityDefinition

Classifier

Classifier of the direction of the transition

Declaration

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

Property value

Type	Description
TransitionClassifier

Trigger

Transition's trigger

Declaration

public TriggerDefinition Trigger { get; set; }

Property value

Type	Description
TriggerDefinition

Conditions

List of conditions which are checked to execute transition

Declaration

public List<ConditionDefinition> Conditions { get; set; }

Property value

Type	Description
List<ConditionDefinition>

Restrictions

List of actors which are determine a user which can execute transition

Declaration

public List<RestrictionDefinition> Restrictions { get; set; }

Property value

Type	Description
List<RestrictionDefinition>

AllowConcatenationType

Type of concatenation for restrictions with the type equal "Allow" RestrictionType.Allow RestrictionDefinition.Type

Declaration

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

Property value

Type	Description
ConcatenationType

RestrictConcatenationType

Type of concatenation for restrictions with the type equal "Restrict" RestrictionType.Restrict RestrictionDefinition.Type

Declaration

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

Property value

Type	Description
ConcatenationType

ConditionsConcatenationType

Type of concatenation for conditions

Declaration

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

Property value

Type	Description
ConcatenationType

Annotations

A List of Annotation attached to this transition.

Declaration

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

Property value

Type	Description
List<Annotation>

HasExpressions

Returns true if the transition has expressions

Declaration

[JsonIgnore]
public bool HasExpressions { get; }

Property value

Type	Description
bool

IsFork

Returns true if Transition initialized or finalized a fork (split, parallel branch). Fork transition is the initial or final transition of a subprocess

Declaration

public bool IsFork { get; set; }

Property value

Type	Description
bool

MergeViaSetState

Returns true if after a subprocess will be merged with a parent process new state of a parent process will be set forcibly

Declaration

public bool MergeViaSetState { get; set; }

Property value

Type	Description
bool

DisableParentStateControl

Applied if transition is fork. False - mean that subprocess will be dropped if parent process turned up in a state where subprocess can not exist. True - mean that subprocess control is responsibility of a developer.

Declaration

public bool DisableParentStateControl { get; set; }

Property value

Type	Description
bool

SubprocessStartupType

Defines how the subprocess starts

Declaration

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

Property value

Type	Description
SubprocessStartupType

SubprocessInOutDefinition

Defines if the transition is start or final

Declaration

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

Property value

Type	Description
SubprocessInOutDefinition

SubprocessName

Subprocess custom name

Declaration

public string SubprocessName { get; set; }

Property value

Type	Description
string

SubprocessId

Subprocess identifier (must be GUID) or expression to get the subprocess identifier from parameters

Declaration

public string SubprocessId { get; set; }

Property value

Type	Description
string

SubprocessStartupParameterCopyStrategy

Determines how parameters from the parent process are passed to the subprocess at startup

Declaration

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

Property value

Type	Description
SubprocessStartupParameterCopyStrategy

SubprocessFinalizeParameterMergeStrategy

Determines how parameters from a subprocess are passed to the parent process when final merge

Declaration

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

Property value

Type	Description
SubprocessFinalizeParameterMergeStrategy

SubprocessSpecifiedParameters

A list of parameters that are either passed or not passed to or from a subprocess (see SubprocessStartupParameterCopyStrategy or SubprocessFinalizeParameterMergeStrategy

Declaration

public string SubprocessSpecifiedParameters { get; set; }

Property value

Type	Description
string

SubprocessSpecifiedParametersList

Declaration

public List<string> SubprocessSpecifiedParametersList { get; }

Property value

Type	Description
List<string>

IsAlwaysTransition

Returns true if condition type of the transition is equal "Always" ConditionType.Always

Declaration

public bool IsAlwaysTransition { get; }

Property value

Type	Description
bool

IsOtherwiseTransition

Returns true if condition type of the transition is equal "Otherwise" ConditionType.Otherwise

Declaration

public bool IsOtherwiseTransition { get; }

Property value

Type	Description
bool

IsConditionTransition

Returns true if condition type of the transition is equal "Action" ConditionType.Action

Declaration

public bool IsConditionTransition { get; }

Property value

Type	Description
bool

ForkType

Returns type of fork transition TransitionForkType

Declaration

[JsonConverter(typeof(StringEnumConverter))]
public TransitionForkType ForkType { get; }

Property value

Type	Description
TransitionForkType

Methods

Create(string, TransitionClassifier, ConcatenationType, ConcatenationType, ConcatenationType, ActivityDefinition, ActivityDefinition, TriggerDefinition, List<ConditionDefinition>)

Create TransitionDefinition object

Declaration

public static TransitionDefinition Create(string name, TransitionClassifier classifier, ConcatenationType allowRestrictionsConcatenationType, ConcatenationType denyRestrictionsConcatenationType, ConcatenationType conditionsConcatenationType, ActivityDefinition from, ActivityDefinition to, TriggerDefinition trigger, List<ConditionDefinition> conditions)

Parameters

Type	Name	Description
string	name	Name of the transition
TransitionClassifier	classifier
ConcatenationType	allowRestrictionsConcatenationType	Type of concatenation for restrictions with the type equal "Allow" <xref href="OptimaJet.Workflow.Core.Model.RestrictionType.Allow" data-throw-if-not-resolved="false"></xref> <xref href="OptimaJet.Workflow.Core.Model.RestrictionDefinition.Type" data-throw-if-not-resolved="false"></xref>
ConcatenationType	denyRestrictionsConcatenationType	Type of concatenation for restrictions with the type equal "Restrict" <xref href="OptimaJet.Workflow.Core.Model.RestrictionType.Restrict" data-throw-if-not-resolved="false"></xref> <xref href="OptimaJet.Workflow.Core.Model.RestrictionDefinition.Type" data-throw-if-not-resolved="false"></xref>
ConcatenationType	conditionsConcatenationType	Type of concatenation for conditions
ActivityDefinition	from	Source activity
ActivityDefinition	to	Destination activity
TriggerDefinition	trigger	Transition's trigger
List<ConditionDefinition>	conditions	List of conditions which are checked to execute transition

Returns

Type	Description
TransitionDefinition	TransitionDefinition object

SetSubprocessSettings(string, string, bool, bool, SubprocessInOutDefinition, SubprocessStartupType, SubprocessStartupParameterCopyStrategy, SubprocessFinalizeParameterMergeStrategy, string)

Sets subprocess specific parameters

Declaration

public TransitionDefinition SetSubprocessSettings(string subprocessName, string subprocessId, bool mergeViaSetState, bool disableParentStateControl, SubprocessInOutDefinition inOutDefinition, SubprocessStartupType startupType, SubprocessStartupParameterCopyStrategy startupParameterCopyStrategy, SubprocessFinalizeParameterMergeStrategy finalizeParameterMergeStrategy, string subprocessSpecifiedParameters)

Parameters

Type	Name	Description
string	subprocessName	Subprocess name or expression in order to calculate subprocess name
string	subprocessId	Subprocess identifier (must be GUID) or expression to get the subprocess identifier from parameters
bool	mergeViaSetState	Returns true if after a subprocess will be merged with a parent process new state of a parent process will be set forcibly
bool	disableParentStateControl	Applied if transition is fork. False - mean that subprocess will be dropped if parent process turned up in a state where subprocess can not exist. True - mean that subprocess control is responsibility of a developer
SubprocessInOutDefinition	inOutDefinition	Defines if the transition is start or final
SubprocessStartupType	startupType	Defines how the subprocess starts
SubprocessStartupParameterCopyStrategy	startupParameterCopyStrategy	Determines how parameters from the parent process are passed to the subprocess at startup
SubprocessFinalizeParameterMergeStrategy	finalizeParameterMergeStrategy	Determines how parameters from a subprocess are passed to the parent process when final merge
string	subprocessSpecifiedParameters	A list of parameters that are either passed or not passed to or from a subprocess (see SubprocessStartupParameterCopyStrategy or SubprocessFinalizeParameterMergeStrategy

Returns

Type	Description
TransitionDefinition

Create(ActivityDefinition, ActivityDefinition)

Create TransitionDefinition object with NotSpecified classifier, Always condition, Auto trigger

Declaration

public static TransitionDefinition Create(ActivityDefinition from, ActivityDefinition to)

Parameters

Type	Name	Description
ActivityDefinition	from	Source activity
ActivityDefinition	to	Destination activity

Returns

Type	Description
TransitionDefinition	TransitionDefinition object

AddRestriction(RestrictionDefinition)

Add restriction to restrictions list

Declaration

public void AddRestriction(RestrictionDefinition restriction)

Parameters

Type	Name	Description
RestrictionDefinition	restriction	RestrictionDefinition object

Clone()

Declaration

public TransitionDefinition Clone()

Returns

Type	Description
TransitionDefinition

Clone(List<ActorDefinition>, List<CommandDefinition>, List<ActivityDefinition>, List<TimerDefinition>)

Clones TransitionDefinition object replacing references to the references to the specific objects

Declaration

public TransitionDefinition Clone(List<ActorDefinition> actorDefinitions, List<CommandDefinition> commandDefinitions, List<ActivityDefinition> activityDefinitions, List<TimerDefinition> timerDefinitions)

Parameters

Type	Name	Description
List<ActorDefinition>	actorDefinitions	List of the actors to replace
List<CommandDefinition>	commandDefinitions	List of the commands to replace
List<ActivityDefinition>	activityDefinitions	List of the activities to replace
List<TimerDefinition>	timerDefinitions	List of the timers to replace

Returns

Type	Description
TransitionDefinition	Cloned TransitionDefinition object

GetAnnotation<T>(string)

Get an annotation attached to this transition

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)