Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Interface IProcessDefinitionBuilder

OptimaJet.Workflow.Core.Model.Builder.IProcessDefinitionBuilder

Represents a builder for configuring a process definition.

Namespace: OptimaJet.Workflow.Core.Model.Builder

public interface IProcessDefinitionBuilder

Properties

Name
Type
ProcessDefinition #
ProcessDefinition
Gets the process definition being built.

Methods

IActorBuilder CreateActor(string name, string rule) #
Creates a new actor with the specified name and rule.

Parameters

Name
Type
Description
name
String
The name of the actor.
rule
String
The rule associated with the actor.

Returns

Type
Description
IActorBuilder
An instance of IActorBuilder.
IActorBuilder CreateOrUpdateActor(string name, string rule) #
Creates or updates an actor with the specified name and rule.

Parameters

Name
Type
Description
name
String
The name of the actor.
rule
String
The rule associated with the actor.

Returns

Type
Description
IActorBuilder
An instance of IActorBuilder.
IActorBuilder UpdateActor(string name) #
Updates an existing actor with the specified name.

Parameters

Name
Type
Description
name
String
The name of the actor to update.

Returns

Type
Description
IActorBuilder
An instance of IActorBuilder.
IProcessDefinitionBuilder DeleteActor(string name) #
Deletes an actor with the specified name.

Parameters

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

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
IParameterBuilder CreateParameter(string name, Type type, ParameterPurpose purpose = ParameterPurpose.Temporary) #
Creates a new parameter with the specified name, type, and purpose.

Parameters

Name
Type
Description
name
String
The name of the parameter.
type
Type
The type of the parameter.
purpose
ParameterPurpose
The purpose of the parameter.

Returns

Type
Description
IParameterBuilder
An instance of IParameterBuilder.
IParameterBuilder CreateOrUpdateParameter(string name, Type type, ParameterPurpose purpose) #
Creates or updates a parameter with the specified name, type, and purpose.

Parameters

Name
Type
Description
name
String
The name of the parameter.
type
Type
The type of the parameter.
purpose
ParameterPurpose
The purpose of the parameter.

Returns

Type
Description
IParameterBuilder
An instance of IParameterBuilder.
IParameterBuilder UpdateParameter(string name) #
Updates an existing parameter with the specified name.

Parameters

Name
Type
Description
name
String
The name of the parameter to update.

Returns

Type
Description
IParameterBuilder
An instance of IParameterBuilder.
IProcessDefinitionBuilder DeleteParameter(string name) #
Deletes a parameter with the specified name.

Parameters

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

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
ICommandBuilder CreateCommand(string name) #
Creates a new command with the specified name.

Parameters

Name
Type
Description
name
String
The name of the command.

Returns

Type
Description
ICommandBuilder
An instance of ICommandBuilder.
ICommandBuilder CreateOrUpdateCommand(string name) #
Creates or updates a command with the specified name.

Parameters

Name
Type
Description
name
String
The name of the command.

Returns

Type
Description
ICommandBuilder
An instance of ICommandBuilder.
ICommandBuilder UpdateCommand(string name) #
Updates an existing command with the specified name.

Parameters

Name
Type
Description
name
String
The name of the command to update.

Returns

Type
Description
ICommandBuilder
An instance of ICommandBuilder.
IProcessDefinitionBuilder DeleteCommand(string name) #
Deletes a command with the specified name.

Parameters

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

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
ITimerBuilder CreateTimer(string name) #
Creates a new timer with the specified name.

Parameters

Name
Type
Description
name
String
The name of the timer.

Returns

Type
Description
ITimerBuilder
An instance of ITimerBuilder.
ICodeActionBuilder CreateCodeAction(string name) #
Creates a new code action with the specified name and CodeActionType.Action type.

Parameters

Name
Type
Description
name
String
The name of the code action.

Returns

Type
Description
ICodeActionBuilder
An instance of ICodeActionBuilder.
ICodeActionBuilder CreateCodeCondition(string name) #
Creates a new code action with the specified name and CodeActionType.Condition type.

Parameters

Name
Type
Description
name
String
The name of the code action.

Returns

Type
Description
ICodeActionBuilder
An instance of ICodeActionBuilder.
ICodeActionBuilder CreateCodeRuleGet(string name) #
Creates a new code action with the specified name and CodeActionType.RuleGet type.

Parameters

Name
Type
Description
name
String
The name of the code action.

Returns

Type
Description
ICodeActionBuilder
An instance of ICodeActionBuilder.
ICodeActionBuilder CreateCodeRuleCheck(string name) #
Creates a new code action with the specified name and CodeActionType.RuleCheck type.

Parameters

Name
Type
Description
name
String
The name of the code action.

Returns

Type
Description
ICodeActionBuilder
An instance of ICodeActionBuilder.
IProcessDefinitionBuilder SetCommonUsings(params string[] usings) #
Sets common using directives for code actions.

Parameters

Name
Type
Description
usings
String[]
Array of using directives shared across all code actions.

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
IProcessDefinitionBuilder AddCommonUsings(params string[] usings) #
Adds common using directives for code actions.

Parameters

Name
Type
Description
usings
String[]
Array of using directives to include in code actions.

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
IProcessDefinitionBuilder RemoveCommonUsings(params string[] usings) #
Removes common using directives from code actions.

Parameters

Name
Type
Description
usings
String[]
Array of using directives to remove from code actions.

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
IProcessDefinitionBuilder ClearCommonUsings() #
Clears all common using directives for code actions.

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
ITimerBuilder CreateOrUpdateTimer(string name) #
Creates or updates a timer with the specified name.

Parameters

Name
Type
Description
name
String
The name of the timer.

Returns

Type
Description
ITimerBuilder
An instance of ITimerBuilder.
ITimerBuilder UpdateTimer(string name) #
Updates an existing timer with the specified name.

Parameters

Name
Type
Description
name
String
The name of the timer to update.

Returns

Type
Description
ITimerBuilder
An instance of ITimerBuilder.
IProcessDefinitionBuilder DeleteTimer(string name) #
Deletes a timer with the specified name.

Parameters

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

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
IActivityBuilder CreateActivity(string name) #
Creates a new activity with the specified name.

Parameters

Name
Type
Description
name
String
The name of the activity.

Returns

Type
Description
IActivityBuilder
An instance of IActivityBuilder.
IActivityBuilder AddActivity(ActivityDefinition activity) #
Adds an activity definition to the process.

Parameters

Name
Type
Description
activity
ActivityDefinition
The activity definition to add.

Returns

Type
Description
IActivityBuilder
An instance of IActivityBuilder.
IInlineActivityBuilder CreateInlineActivity(string name, string schemeCode) #
Creates a new inline activity with the specified name and scheme code.

Parameters

Name
Type
Description
name
String
The name of the activity.
schemeCode
String
The scheme code of the activity.

Returns

Type
Description
IInlineActivityBuilder
An instance of IInlineActivityBuilder.
IActivityBuilder CreateOrUpdateActivity(string name) #
Creates or updates an activity with the specified name.

Parameters

Name
Type
Description
name
String
The name of the activity.

Returns

Type
Description
IActivityBuilder
An instance of IActivityBuilder.
IInlineActivityBuilder CreateOrUpdateInlineActivity(string name, string schemeCode) #
Creates or updates an inline activity with the specified name and scheme code.

Parameters

Name
Type
Description
name
String
The name of the activity.
schemeCode
String
The scheme code of the activity.

Returns

Type
Description
IInlineActivityBuilder
An instance of IInlineActivityBuilder.
IActivityBuilder UpdateActivity(string name) #
Updates an existing activity with the specified name.

Parameters

Name
Type
Description
name
String
The name of the activity to update.

Returns

Type
Description
IActivityBuilder
An instance of IActivityBuilder.
IInlineActivityBuilder UpdateInlineActivity(string name) #
Updates an existing inline activity with the specified name.

Parameters

Name
Type
Description
name
String
The name of the activity to update.

Returns

Type
Description
IInlineActivityBuilder
An instance of IInlineActivityBuilder.
IActivityBuilder UpdateActivity(ActivityDefinition activity) #
Updates an existing activity definition.

Parameters

Name
Type
Description
activity
ActivityDefinition
The activity definition to update.

Returns

Type
Description
IActivityBuilder
An instance of IActivityBuilder.
IInlineActivityBuilder UpdateInlineActivity(ActivityDefinition activity) #
Updates an existing inline activity definition.

Parameters

Name
Type
Description
activity
ActivityDefinition
The inline activity definition to update.

Returns

Type
Description
IInlineActivityBuilder
An instance of IInlineActivityBuilder.
IProcessDefinitionBuilder DeleteActivity(string name) #
Deletes an activity with the specified name.

Parameters

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

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
IProcessDefinitionBuilder DeleteActivity(ActivityDefinition activity) #
Deletes an activity definition.

Parameters

Name
Type
Description
activity
ActivityDefinition
The activity definition to delete.

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
ITransitionBuilder CreateTransition(string name, ActivityDefinition from, ActivityDefinition to) #
Creates a new transition with the specified name, source activity, and target activity.

Parameters

Name
Type
Description
name
String
The name of the transition.
from
ActivityDefinition
The source activity of the transition.
to
ActivityDefinition
The target activity of the transition.

Returns

Type
Description
ITransitionBuilder
An instance of ITransitionBuilder.
ITransitionBuilder CreateOrUpdateTransition(string name, ActivityDefinition from, ActivityDefinition to) #
Creates or updates a transition with the specified name, source activity, and target activity.

Parameters

Name
Type
Description
name
String
The name of the transition.
from
ActivityDefinition
The source activity of the transition.
to
ActivityDefinition
The target activity of the transition.

Returns

Type
Description
ITransitionBuilder
An instance of ITransitionBuilder.
ITransitionBuilder UpdateTransition(string name) #
Updates an existing transition with the specified name.

Parameters

Name
Type
Description
name
String
The name of the transition to update.

Returns

Type
Description
ITransitionBuilder
An instance of ITransitionBuilder.
ITransitionBuilder UpdateTransition(TransitionDefinition transition) #
Updates an existing transition definition.

Parameters

Name
Type
Description
transition
TransitionDefinition
The transition definition to update.

Returns

Type
Description
ITransitionBuilder
An instance of ITransitionBuilder.
IProcessDefinitionBuilder DeleteTransition(string name) #
Deletes a transition with the specified name.

Parameters

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

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
IProcessDefinitionBuilder DeleteTransition(TransitionDefinition transition) #
Deletes a transition definition.

Parameters

Name
Type
Description
transition
TransitionDefinition
The transition definition to delete.

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
IProcessDefinitionBuilder ForEachActivity(Action<IActivityBuilder> action) #
Applies an action to each activity in the process definition.

Parameters

Name
Type
Description
action
Action<IActivityBuilder>
The action to apply to each activity.

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
IProcessDefinitionBuilder ForEachTransition(Action<ITransitionBuilder> action) #
Applies an action to each transition in the process definition.

Parameters

Name
Type
Description
action
Action<ITransitionBuilder>
The action to apply to each transition.

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
IProcessDefinitionBuilder Inlined() #
Marks the process as capable of being inlined.

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
IProcessDefinitionBuilder NotInlined() #
Marks the process as not capable of being inlined.

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
IProcessDefinitionBuilder SetTenantId(string? tenantId) #
Sets the tenant identifier for the process definition.

Parameters

Name
Type
Description
tenantId
String
The tenant identifier. Use null to clear the tenant scope.

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
IProcessDefinitionBuilder GetActivity(string name, out ActivityDefinition activity) #
Retrieves an activity definition by name.

Parameters

Name
Type
Description
name
String
The name of the activity.
activity
ActivityDefinition
The retrieved activity definition.

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
IProcessDefinitionBuilder GetTransition(string name, out TransitionDefinition transition) #
Retrieves a transition definition by name.

Parameters

Name
Type
Description
name
String
The name of the transition.
transition
TransitionDefinition
The retrieved transition definition.

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
IProcessDefinitionBuilder CreateOrUpdateLocalizationForState(string stateName, CultureInfo culture, string value, bool isDefault = false) #
Adds or updates localization for the specific state in the specified culture.

Parameters

Name
Type
Description
stateName
String
Name of the state.
culture
CultureInfo
Culture (language) for which the localization value applies.
value
String
State name in the specified culture.
isDefault
Boolean
If set to true, this indicates that the record will be used as the default when a record with the specified culture is unavailable.

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.
IProcessDefinitionBuilder DeleteLocalizationForState(string stateName, CultureInfo culture) #
Removes localization for the specific state in the specified culture.

Parameters

Name
Type
Description
stateName
String
Name of the state.
culture
CultureInfo
Culture (language) for which the localization value is removed.

Returns

Type
Description
IProcessDefinitionBuilder
IProcessDefinitionBuilder DeleteAllLocalizationsForState(string stateName) #
Clears all localizations for the specific state.

Parameters

Name
Type
Description
stateName
String
Name of the state.

Returns

Type
Description
IProcessDefinitionBuilder
An instance of IProcessDefinitionBuilder.

Derived Types