Interface ITransitionBuilder

Represents a builder for configuring a transition definition.

Inherited Members

IProcessDefinitionBuilder.CreateActor(string, string)

IProcessDefinitionBuilder.CreateOrUpdateActor(string, string)

IProcessDefinitionBuilder.UpdateActor(string)

IProcessDefinitionBuilder.DeleteActor(string)

IProcessDefinitionBuilder.CreateParameter(string, Type, ParameterPurpose)

IProcessDefinitionBuilder.CreateOrUpdateParameter(string, Type, ParameterPurpose)

IProcessDefinitionBuilder.UpdateParameter(string)

IProcessDefinitionBuilder.DeleteParameter(string)

IProcessDefinitionBuilder.CreateCommand(string)

IProcessDefinitionBuilder.CreateOrUpdateCommand(string)

IProcessDefinitionBuilder.UpdateCommand(string)

IProcessDefinitionBuilder.DeleteCommand(string)

IProcessDefinitionBuilder.CreateTimer(string)

IProcessDefinitionBuilder.CreateOrUpdateTimer(string)

IProcessDefinitionBuilder.UpdateTimer(string)

IProcessDefinitionBuilder.DeleteTimer(string)

IProcessDefinitionBuilder.CreateActivity(string)

IProcessDefinitionBuilder.AddActivity(ActivityDefinition)

IProcessDefinitionBuilder.CreateInlineActivity(string, string)

IProcessDefinitionBuilder.CreateOrUpdateActivity(string)

IProcessDefinitionBuilder.CreateOrUpdateInlineActivity(string, string)

IProcessDefinitionBuilder.UpdateActivity(string)

IProcessDefinitionBuilder.UpdateInlineActivity(string)

IProcessDefinitionBuilder.UpdateActivity(ActivityDefinition)

IProcessDefinitionBuilder.UpdateInlineActivity(ActivityDefinition)

IProcessDefinitionBuilder.DeleteActivity(string)

IProcessDefinitionBuilder.DeleteActivity(ActivityDefinition)

IProcessDefinitionBuilder.CreateTransition(string, ActivityDefinition, ActivityDefinition)

IProcessDefinitionBuilder.CreateOrUpdateTransition(string, ActivityDefinition, ActivityDefinition)

IProcessDefinitionBuilder.UpdateTransition(string)

IProcessDefinitionBuilder.UpdateTransition(TransitionDefinition)

IProcessDefinitionBuilder.DeleteTransition(string)

IProcessDefinitionBuilder.DeleteTransition(TransitionDefinition)

IProcessDefinitionBuilder.ForEachActivity(Action<IActivityBuilder>)

IProcessDefinitionBuilder.ForEachTransition(Action<ITransitionBuilder>)

IProcessDefinitionBuilder.Inlined()

IProcessDefinitionBuilder.NotInlined()

IProcessDefinitionBuilder.GetActivity(string, out ActivityDefinition)

IProcessDefinitionBuilder.GetTransition(string, out TransitionDefinition)

IProcessDefinitionBuilder.ProcessDefinition

Namespace: OptimaJet.Workflow.Core.Model.Builder

Assembly: OptimaJet.Workflow.Core.dll

Syntax

public interface ITransitionBuilder : IProcessDefinitionBuilder

Methods

Name(string)

Sets the name of the transition.

Declaration

ITransitionBuilder Name(string name)

Parameters

Type	Name	Description
string	name	The name of the transition.

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

From(ActivityDefinition)

Specifies the source activity from which the transition originates.

Declaration

ITransitionBuilder From(ActivityDefinition activityDefinition)

Parameters

Type	Name	Description
ActivityDefinition	activityDefinition	The definition of the source activity.

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

To(ActivityDefinition)

Specifies the destination activity to which the transition leads.

Declaration

ITransitionBuilder To(ActivityDefinition activityDefinition)

Parameters

Type	Name	Description
ActivityDefinition	activityDefinition	The definition of the destination activity.

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

Auto()

Configures the transition to be automatic, triggering without any external input.

Declaration

ITransitionBuilder Auto()

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

TriggeredByTimer(TimerDefinition)

Configures the transition to be triggered by a timer.

Declaration

ITransitionBuilder TriggeredByTimer(TimerDefinition timerDefinition)

Parameters

Type	Name	Description
TimerDefinition	timerDefinition	The timer definition that specifies when the transition is triggered.

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

TriggeredByCommand(CommandDefinition)

Configures the transition to be triggered by a command.

Declaration

ITransitionCommandBuilder TriggeredByCommand(CommandDefinition commandDefinition)

Parameters

Type	Name	Description
CommandDefinition	commandDefinition	The command definition that specifies the trigger.

Returns

Type	Description
ITransitionCommandBuilder	An instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionCommandBuilder" data-throw-if-not-resolved="false"></xref> for further command-specific configurations.

UpdateCommandTrigger()

Updates the trigger of the transition to the specified command if the transition is currently triggered by a command.

Declaration

ITransitionCommandBuilder UpdateCommandTrigger()

Returns

Type	Description
ITransitionCommandBuilder	An instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionCommandBuilder" data-throw-if-not-resolved="false"></xref> for further command-specific configurations.

Direct()

Configures the transition to be direct, without reversing or changing direction.

Declaration

ITransitionBuilder Direct()

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

Reverse()

Configures the transition to be reversed, indicating the opposite direction.

Declaration

ITransitionBuilder Reverse()

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

DirectionNotSpecified()

Specifies that the direction of the transition is not specified.

Declaration

ITransitionBuilder DirectionNotSpecified()

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

Conditional()

Adds conditions to the transition, allowing it to be conditional based on certain criteria.

Declaration

ITransitionConditionsBuilder Conditional()

Returns

Type	Description
ITransitionConditionsBuilder	An instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionConditionsBuilder" data-throw-if-not-resolved="false"></xref> for configuring the conditions.

Always()

Sets the transition to always occur, regardless of conditions.

Declaration

ITransitionBuilder Always()

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

Otherwise()

Sets the transition to occur as an "otherwise" condition, typically when other conditions are not met.

Declaration

ITransitionBuilder Otherwise()

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

CreateOrUpdateAnnotation(string, string)

Creates or updates an annotation for the transition with a string value.

Declaration

ITransitionBuilder CreateOrUpdateAnnotation(string name, string value)

Parameters

Type	Name	Description
string	name	The name of the annotation.
string	value	The value of the annotation in JSON format.

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

CreateOrUpdateAnnotation(string, object)

Creates or updates an annotation for the transition with an object value.

Declaration

ITransitionBuilder CreateOrUpdateAnnotation(string name, object value)

Parameters

Type	Name	Description
string	name	The name of the annotation.
object	value	The value of the annotation as an object.

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

DeleteAnnotation(string)

Deletes an annotation from the transition.

Declaration

ITransitionBuilder DeleteAnnotation(string name)

Parameters

Type	Name	Description
string	name	The name of the annotation to delete.

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

NotParallel()

Configures the transition to not be parallel, effectively disabling fork functionality.

Declaration

ITransitionBuilder NotParallel()

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

ParallelStart()

Begins configuration for starting a parallel subprocess.

Declaration

ITransitionParallelStartBuilder ParallelStart()

Returns

Type	Description
ITransitionParallelStartBuilder	An instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionParallelStartBuilder" data-throw-if-not-resolved="false"></xref> for further configuration.

ParallelFinalize()

Begins configuration for finalizing a parallel subprocess.

Declaration

ITransitionParallelFinalizeBuilder ParallelFinalize()

Returns

Type	Description
ITransitionParallelFinalizeBuilder	An instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionParallelFinalizeBuilder" data-throw-if-not-resolved="false"></xref> for further configuration.

CreateCommentary(string)

Creates a user commentary for the transition.

Declaration

ITransitionBuilder CreateCommentary(string comment)

Parameters

Type	Name	Description
string	comment	The commentary text.

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

AppendCommentary(string)

Appends additional commentary to the existing user commentary for the transition.

Declaration

ITransitionBuilder AppendCommentary(string comment)

Parameters

Type	Name	Description
string	comment	The additional commentary text.

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

DeleteCommentary()

Deletes the user commentary associated with the transition.

Declaration

ITransitionBuilder DeleteCommentary()

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

SetX(int?)

Sets the X coordinate for the transition in the designer.

Declaration

ITransitionBuilder SetX(int? x)

Parameters

Type	Name	Description
int?	x	The X coordinate.

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

SetY(int?)

Sets the Y coordinate for the transition in the designer.

Declaration

ITransitionBuilder SetY(int? y)

Parameters

Type	Name	Description
int?	y	The Y coordinate.

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

Ref(out TransitionDefinition)

Provides a reference to the current transition definition.

Declaration

ITransitionBuilder Ref(out TransitionDefinition transition)

Parameters

Type	Name	Description
TransitionDefinition	transition	The current transition definition.

Returns

Type	Description
ITransitionBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder" data-throw-if-not-resolved="false"></xref>.

Extension Methods

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