Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Interface IActivityBuilder

OptimaJet.Workflow.Core.Model.Builder.IActivityBuilder

Represents a builder for configuring an activity.

Namespace: OptimaJet.Workflow.Core.Model.Builder

public interface IActivityBuilder : IBaseActivityBuilder, IProcessDefinitionBuilder

Methods

IActivityBuilder Name(string name) #
Sets the name of the current activity.

Parameters

Name
Type
Description
name
String
The name of the activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder State(string state) #
Sets the state of the current activity.

Parameters

Name
Type
Description
state
String
The state of the activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder NotState() #
Resets the state of the current activity and marks it as not for set state.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder DisableSetState() #
Disables the set state functionality for the current activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder EnableSetState() #
Enables the set state functionality for the current activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder Initial() #
Marks the current activity as initial.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder Final() #
Marks the current activity as final.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder Basic() #
Marks the current activity as neither initial nor final.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder EnableAutoSchemeUpdate() #
Enables automatic scheme updates for the current activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder DisableAutoSchemeUpdate() #
Disables automatic scheme updates for the current activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder CreateOrUpdateAnnotation(string name, string value) #
Creates or updates an annotation for the current activity.

Parameters

Name
Type
Description
name
String
The name of the annotation.
value
String
The value of the annotation.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder CreateOrUpdateAnnotation(string name, object value) #
Creates or updates an annotation for the current activity.

Parameters

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

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder DeleteAnnotation(string name) #
Deletes an annotation from the current activity.

Parameters

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

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder DisablePersistence() #
Disables persistence for the current activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder EnablePersistence() #
Enables persistence for the current activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder DisableTransitionHistoryPersistence() #
Disables transition history persistence for the current activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder EnableTransitionHistoryPersistence() #
Enables transition history persistence for the current activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder DisableParametersPersistence() #
Disables parameter persistence for the current activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder EnableParametersPersistence() #
Enables parameter persistence for the current activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder DisableStatePersistence() #
Disables state persistence for the current activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder EnableStatePersistence() #
Enables state persistence for the current activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IIdleTimeoutBuilder IdleTimeout(TimeSpan timeout) #
Sets the idle timeout for the current activity.

Parameters

Name
Type
Description
timeout
TimeSpan
The timeout value.

Returns

Type
Description
IIdleTimeoutBuilder
An IIdleTimeoutBuilder for configuring the timeout.
IIdleTimeoutBuilder IdleTimeout(int timeout) #
Sets the idle timeout for the current activity.

Parameters

Name
Type
Description
timeout
Int32
The timeout value in seconds.

Returns

Type
Description
IIdleTimeoutBuilder
An IIdleTimeoutBuilder for configuring the timeout.
IActivityBuilder DeleteIdleTimeout() #
Deletes the idle timeout for the current activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IIdleTimeoutBuilder UpdateIdleTimeout() #
Updates the idle timeout for the current activity.

Returns

Type
Description
IIdleTimeoutBuilder
An IIdleTimeoutBuilder for configuring the timeout.
IExecutionTimeoutBuilder ExecutionTimeout(TimeSpan timeout) #
Sets the execution timeout for the current activity.

Parameters

Name
Type
Description
timeout
TimeSpan
The timeout value.

Returns

Type
Description
IExecutionTimeoutBuilder
An IExecutionTimeoutBuilder for configuring the timeout.
IExecutionTimeoutBuilder ExecutionTimeout(int timeout) #
Sets the execution timeout for the current activity.

Parameters

Name
Type
Description
timeout
Int32
The timeout value in seconds.

Returns

Type
Description
IExecutionTimeoutBuilder
An IExecutionTimeoutBuilder for configuring the timeout.
IExecutionTimeoutBuilder UpdateExecutionTimeout() #
Updates the execution timeout for the current activity.

Returns

Type
Description
IExecutionTimeoutBuilder
An IExecutionTimeoutBuilder for configuring the timeout.
IActivityBuilder DeleteExecutionTimeout() #
Deletes the execution timeout for the current activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityExceptionHandlerBuilder CreateOrUpdateExceptionHandler(params string[] exceptions) #
Creates or updates an exception handler for the current activity.

Parameters

Name
Type
Description
exceptions
String[]
The exceptions to handle.

Returns

Type
Description
IActivityExceptionHandlerBuilder
An IActivityExceptionHandlerBuilder for configuring the exception handler.
IActivityExceptionHandlerBuilder CreateOrUpdateExceptionHandler(params Type[] exceptions) #
Creates or updates an exception handler for the current activity.

Parameters

Name
Type
Description
exceptions
Type[]
The exceptions to handle.

Returns

Type
Description
IActivityExceptionHandlerBuilder
An IActivityExceptionHandlerBuilder for configuring the exception handler.
IActivityBuilder DeleteExceptionHandler(params string[] exceptions) #
Deletes an exception handler for the specified exceptions from the current activity.

Parameters

Name
Type
Description
exceptions
String[]
The exceptions to remove from the handler.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder DeleteExceptionHandler(params Type[] exceptions) #
Deletes an exception handler for the specified exceptions from the current activity.

Parameters

Name
Type
Description
exceptions
Type[]
The exceptions to remove from the handler.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder DeleteExceptionHandlers() #
Deletes all exception handlers from the current activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder DeleteImplementation(string? actionName = null) #
Deletes the implementation with the specified action name from the current activity.

Parameters

Name
Type
Description
actionName
String
The name of the action to delete. If null, all implementations are deleted.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityImplementationBuilder UpdateImplementation(string actionName) #
Updates the implementation with the specified action name for the current activity.

Parameters

Name
Type
Description
actionName
String
The name of the action to update.

Returns

Type
Description
IActivityImplementationBuilder
An IActivityImplementationBuilder for configuring the implementation.
IActivityImplementationBuilder CreateImplementationAtBegin(string actionName) #
Creates an implementation at the beginning of the list for the current activity.

Parameters

Name
Type
Description
actionName
String
The name of the action to create.

Returns

Type
Description
IActivityImplementationBuilder
An IActivityImplementationBuilder for configuring the implementation.
IActivityImplementationBuilder CreateImplementationAtEnd(string actionName) #
Creates a pre-execution implementation at the end of the list for the current activity.

Parameters

Name
Type
Description
actionName
String
The name of the action to create.

Returns

Type
Description
IActivityImplementationBuilder
An IActivityImplementationBuilder for configuring the implementation.
IActivityImplementationBuilder CreateImplementationBefore(string actionName, string targetActionName) #
Creates a pre-execution implementation before the specified target action for the current activity.

Parameters

Name
Type
Description
actionName
String
The name of the action to create.
targetActionName
String
The name of the target action before which the new action will be created.

Returns

Type
Description
IActivityImplementationBuilder
An IActivityImplementationBuilder for configuring the implementation.
IActivityImplementationBuilder CreateImplementationAfter(string actionName, string targetActionName) #
Creates a pre-execution implementation after the specified target action for the current activity.

Parameters

Name
Type
Description
actionName
String
The name of the action to create.
targetActionName
String
The name of the target action after which the new action will be created.

Returns

Type
Description
IActivityImplementationBuilder
An IActivityImplementationBuilder for configuring the implementation.
IActivityBuilder DeletePreExecution(string? actionName = null) #
Deletes the pre-execution implementation with the specified action name from the current activity.

Parameters

Name
Type
Description
actionName
String
The name of the action to delete. If null, all pre-execution implementations are deleted.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityImplementationBuilder UpdatePreExecution(string actionName) #
Updates the pre-execution implementation with the specified action name for the current activity.

Parameters

Name
Type
Description
actionName
String
The name of the action to update.

Returns

Type
Description
IActivityImplementationBuilder
An IActivityImplementationBuilder for configuring the implementation.
IActivityImplementationBuilder CreatePreExecutionAtBegin(string actionName) #
Creates a pre-execution implementation at the beginning of the list for the current activity.

Parameters

Name
Type
Description
actionName
String
The name of the action to create.

Returns

Type
Description
IActivityImplementationBuilder
An IActivityImplementationBuilder for configuring the implementation.
IActivityImplementationBuilder CreatePreExecutionAtEnd(string actionName) #
Creates a pre-execution implementation at the end of the list for the current activity.

Parameters

Name
Type
Description
actionName
String
The name of the action to create.

Returns

Type
Description
IActivityImplementationBuilder
An IActivityImplementationBuilder for configuring the implementation.
IActivityImplementationBuilder CreatePreExecutionBefore(string actionName, string targetActionName) #
Creates a pre-execution implementation before the specified target action for the current activity.

Parameters

Name
Type
Description
actionName
String
The name of the action to create.
targetActionName
String
The name of the target action before which the new action will be created.

Returns

Type
Description
IActivityImplementationBuilder
An IActivityImplementationBuilder for configuring the implementation.
IActivityImplementationBuilder CreatePreExecutionAfter(string actionName, string targetActionName) #
Creates a pre-execution implementation after the specified target action for the current activity.

Parameters

Name
Type
Description
actionName
String
The name of the action to create.
targetActionName
String
The name of the target action after which the new action will be created.

Returns

Type
Description
IActivityImplementationBuilder
An IActivityImplementationBuilder for configuring the implementation.
IActivityBuilder CreateCommentary(string comment) #
Creates a commentary for the current activity.

Parameters

Name
Type
Description
comment
String
The commentary text.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder AppendCommentary(string comment) #
Appends a commentary to the current activity.

Parameters

Name
Type
Description
comment
String
The commentary text to append.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder DeleteCommentary() #
Deletes the commentary from the current activity.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder SetX(int? x) #
Sets the X coordinate for the current activity's designer settings.

Parameters

Name
Type
Description
x
Nullable<Int32>
The X coordinate.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder SetY(int? y) #
Sets the Y coordinate for the current activity's designer settings.

Parameters

Name
Type
Description
y
Nullable<Int32>
The Y coordinate.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder CustomType(string customType) #
Sets a custom type for the current activity.

Parameters

Name
Type
Description
customType
String
The custom type.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.
IActivityBuilder Ref(out ActivityDefinition activityDefinition) #
Gets the current activity definition.

Parameters

Name
Type
Description
activityDefinition
ActivityDefinition
The output activity definition.

Returns

Type
Description
IActivityBuilder
The current IActivityBuilder instance.