Assembly: OptimaJet.Workflow.Core

Interface ITransitionBuilder

OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder

Provides a fluent API for configuring a TransitionDefinition within a process scheme.

Namespace: OptimaJet.Workflow.Core.Model.Builder

public interface ITransitionBuilder : IProcessDefinitionBuilder

Type Hierarchy

Properties

TransitionDefinition Transition { get; } #
Gets the TransitionDefinition currently being configured.

Methods

ITransitionBuilder Name(string name) #
Sets the transition name.

Parameters

Name
Type
Description
name
String
The name to assign.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.
ITransitionBuilder From(ActivityDefinition activityDefinition) #
Sets TransitionDefinition.From, the source activity from which the transition starts.

Parameters

Name
Type
Description
activityDefinition
ActivityDefinition
The source ActivityDefinition.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.
ITransitionBuilder To(ActivityDefinition activityDefinition) #
Sets TransitionDefinition.To, the target activity to which the transition leads.

Parameters

Name
Type
Description
activityDefinition
ActivityDefinition
The target ActivityDefinition.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.
ITransitionBuilder Auto() #
Sets TransitionDefinition.Trigger to TriggerDefinition.Auto and clears TransitionDefinition.Restrictions.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.
ITransitionBuilder TriggeredByTimer(TimerDefinition timerDefinition) #
Sets TransitionDefinition.Trigger to a TriggerType.Timer trigger and clears TransitionDefinition.Restrictions.

Parameters

Name
Type
Description
timerDefinition
TimerDefinition
The TimerDefinition associated with the trigger.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.
ITransitionCommandBuilder TriggeredByCommand(CommandDefinition commandDefinition) #
Sets TransitionDefinition.Trigger to a TriggerType.Command trigger.

Parameters

Name
Type
Description
commandDefinition
CommandDefinition
The CommandDefinition associated with the trigger.

Returns

Type
Description
ITransitionCommandBuilder
An ITransitionCommandBuilder for configuring TransitionDefinition.Restrictions.
ITransitionCommandBuilder UpdateCommandTrigger() #
Opens command-specific configuration when TransitionDefinition.Trigger is a TriggerType.Command trigger.

Returns

Type
Description
ITransitionCommandBuilder
An ITransitionCommandBuilder for configuring TransitionDefinition.Restrictions.

Exceptions

Type
Description
InvalidOperationException
The transition does not have a TriggerType.Command trigger.
ITransitionBuilder Direct() #
Sets TransitionDefinition.Classifier to TransitionClassifier.Direct, classifying the transition as forward.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.
ITransitionBuilder Reverse() #
Sets TransitionDefinition.Classifier to TransitionClassifier.Reverse, classifying the transition as backward or corrective.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.
ITransitionBuilder DirectionNotSpecified() #
Sets TransitionDefinition.Classifier to TransitionClassifier.NotSpecified.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.
ITransitionConditionsBuilder Conditional() #
Begins configuring ConditionType.Action and ConditionType.Expression conditions.

Returns

Type
Description
ITransitionConditionsBuilder
An ITransitionConditionsBuilder for configuring the conditions.

Remarks

Existing ConditionType.Always and ConditionType.Otherwise conditions are removed.
ITransitionBuilder Always() #
Replaces TransitionDefinition.Conditions with a single ConditionType.Always condition.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.

Remarks

Also sets TransitionDefinition.ConditionsConcatenationType to ConcatenationType.And.
ITransitionBuilder Otherwise() #
Replaces TransitionDefinition.Conditions with a single fallback ConditionType.Otherwise condition.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.

Remarks

Also sets TransitionDefinition.ConditionsConcatenationType to ConcatenationType.And.
ITransitionBuilder CreateOrUpdateAnnotation(string name, string value) #
Creates or updates an Annotation named name on the transition, storing value unchanged.

Parameters

Name
Type
Description
name
String
The name of the annotation.
value
String
The string value to store; it may contain plain text or JSON.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.
ITransitionBuilder CreateOrUpdateAnnotation(string name, object value) #
Creates or updates an Annotation named name on the transition, storing the JSON serialization of value.

Parameters

Name
Type
Description
name
String
The name of the annotation.
value
Object
The object to serialize and store.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.
ITransitionBuilder DeleteAnnotation(string name) #
Removes all transition annotations named name.

Parameters

Name
Type
Description
name
String
The annotation name to remove.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.
ITransitionBuilder NotParallel() #
Configures the transition as a TransitionForkType.NotFork transition.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.

Remarks

Sets TransitionDefinition.IsFork to false.
ITransitionParallelStartBuilder ParallelStart() #
Configures a TransitionForkType.ForkStart transition by setting TransitionDefinition.IsFork to true and TransitionDefinition.SubprocessInOutDefinition to SubprocessInOutDefinition.Start.

Returns

Type
Description
ITransitionParallelStartBuilder
An ITransitionParallelStartBuilder for configuring subprocess startup.
ITransitionParallelFinalizeBuilder ParallelFinalize() #
Configures a TransitionForkType.ForkEnd transition by setting TransitionDefinition.IsFork to true and TransitionDefinition.SubprocessInOutDefinition to SubprocessInOutDefinition.Finalize.

Returns

Type
Description
ITransitionParallelFinalizeBuilder
An ITransitionParallelFinalizeBuilder for configuring subprocess finalization.
ITransitionBuilder CreateCommentary(string comment) #
Sets TransitionDefinition.UserComment, replacing any current value.

Parameters

Name
Type
Description
comment
String
The comment to assign.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.
ITransitionBuilder AppendCommentary(string comment) #
Appends comment to TransitionDefinition.UserComment, inserting a newline before it when the current comment is nonempty.

Parameters

Name
Type
Description
comment
String
The comment text to append.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.
ITransitionBuilder DeleteCommentary() #
Sets TransitionDefinition.UserComment to null.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.
ITransitionBuilder SetX(int? x) #
Sets DesignerSettings.X in the transition's BaseDefinition.DesignerSettings.

Parameters

Name
Type
Description
x
Nullable<Int32>
The horizontal coordinate, or null to clear it.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.
ITransitionBuilder SetY(int? y) #
Sets DesignerSettings.Y in the transition's BaseDefinition.DesignerSettings.

Parameters

Name
Type
Description
y
Nullable<Int32>
The vertical coordinate, or null to clear it.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.
ITransitionBuilder Ref(out TransitionDefinition transition) #
Assigns the TransitionDefinition currently being configured to transition.

Parameters

Name
Type
Description
transition
TransitionDefinition
When this method returns, contains the TransitionDefinition being configured.

Returns

Type
Description
ITransitionBuilder
The current ITransitionBuilder instance.