Interface ITransitionBuilder
OptimaJet.Workflow.Core.Model.Builder.ITransitionBuilder
Represents a builder for configuring a transition definition.
Namespace: OptimaJet.Workflow.Core.Model.Builder
public interface ITransitionBuilder : IProcessDefinitionBuilderProperties
Methods
ITransitionBuilder Name(string name) #Sets the name of the transition.
Parameters
Name
Type
Description
nameStringThe name of the transition.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionBuilder From(ActivityDefinition activityDefinition) #Specifies the source activity from which the transition originates.
Parameters
Name
Type
Description
activityDefinitionActivityDefinitionThe definition of the source activity.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionBuilder To(ActivityDefinition activityDefinition) #Specifies the destination activity to which the transition leads.
Parameters
Name
Type
Description
activityDefinitionActivityDefinitionThe definition of the destination activity.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionBuilder Auto() #Configures the transition to be automatic, triggering without any external input.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionBuilder TriggeredByTimer(TimerDefinition timerDefinition) #Configures the transition to be triggered by a timer.
Parameters
Name
Type
Description
timerDefinitionTimerDefinitionThe timer definition that specifies when the transition is triggered.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionCommandBuilder TriggeredByCommand(CommandDefinition commandDefinition) #Configures the transition to be triggered by a command.
Parameters
Name
Type
Description
commandDefinitionCommandDefinitionThe command definition that specifies the trigger.
Returns
Type
Description
ITransitionCommandBuilderAn instance of ITransitionCommandBuilder for further command-specific configurations.
ITransitionCommandBuilder UpdateCommandTrigger() #Updates the trigger of the transition to the specified command if the transition is currently triggered by a command.
Returns
Type
Description
ITransitionCommandBuilderAn instance of ITransitionCommandBuilder for further command-specific configurations.
ITransitionBuilder Direct() #Configures the transition to be direct, without reversing or changing direction.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionBuilder Reverse() #Configures the transition to be reversed, indicating the opposite direction.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionBuilder DirectionNotSpecified() #Specifies that the direction of the transition is not specified.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionConditionsBuilder Conditional() #Adds conditions to the transition, allowing it to be conditional based on certain criteria.
Returns
Type
Description
ITransitionConditionsBuilderAn instance of ITransitionConditionsBuilder for configuring the conditions.
ITransitionBuilder Always() #Sets the transition to always occur, regardless of conditions.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionBuilder Otherwise() #Sets the transition to occur as an "otherwise" condition, typically when other conditions are not met.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionBuilder CreateOrUpdateAnnotation(string name, string value) #Creates or updates an annotation for the transition with a string value.
Parameters
Name
Type
Description
nameStringThe name of the annotation.
valueStringThe value of the annotation in JSON format.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionBuilder CreateOrUpdateAnnotation(string name, object value) #Creates or updates an annotation for the transition with an object value.
Parameters
Name
Type
Description
nameStringThe name of the annotation.
valueObjectThe value of the annotation as an object.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionBuilder DeleteAnnotation(string name) #Deletes an annotation from the transition.
Parameters
Name
Type
Description
nameStringThe name of the annotation to delete.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionBuilder NotParallel() #Configures the transition to not be parallel, effectively disabling fork functionality.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionParallelStartBuilder ParallelStart() #Begins configuration for starting a parallel subprocess.
Returns
Type
Description
ITransitionParallelStartBuilderAn instance of ITransitionParallelStartBuilder for further configuration.
ITransitionParallelFinalizeBuilder ParallelFinalize() #Begins configuration for finalizing a parallel subprocess.
Returns
Type
Description
ITransitionParallelFinalizeBuilderAn instance of ITransitionParallelFinalizeBuilder for further configuration.
ITransitionBuilder CreateCommentary(string comment) #Creates a user commentary for the transition.
Parameters
Name
Type
Description
commentStringThe commentary text.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionBuilder AppendCommentary(string comment) #Appends additional commentary to the existing user commentary for the transition.
Parameters
Name
Type
Description
commentStringThe additional commentary text.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionBuilder DeleteCommentary() #Deletes the user commentary associated with the transition.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionBuilder SetX(int? x) #Sets the X coordinate for the transition in the designer.
Parameters
Name
Type
Description
xNullable<Int32>The X coordinate.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionBuilder SetY(int? y) #Sets the Y coordinate for the transition in the designer.
Parameters
Name
Type
Description
yNullable<Int32>The Y coordinate.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.
ITransitionBuilder Ref(out TransitionDefinition transition) #Provides a reference to the current transition definition.
Parameters
Name
Type
Description
transitionTransitionDefinitionThe current transition definition.
Returns
Type
Description
ITransitionBuilderThe current instance of ITransitionBuilder.