Assembly: OptimaJet.Workflow.Core

Interface IWorkflowActionProvider

OptimaJet.Workflow.Core.Runtime.IWorkflowActionProvider

Provides workflow actions and conditions from runtime definitions.

public interface IWorkflowActionProvider

Type Hierarchy

Methods

void ExecuteAction(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter) #
Executes an action.

Parameters

Name
Type
Description
name
String
Name of the action to execute.
processInstance
ProcessInstance
The process instance from which the action is executed. ProcessInstance
runtime
WorkflowRuntime
The runtime instance that manages the process instance. WorkflowRuntime
actionParameter
String
Additional action parameter value. ActionDefinitionReference.ActionParameter
Task ExecuteActionAsync(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter, CancellationToken token) #
Executes an action asynchronously.

Parameters

Name
Type
Description
name
String
Name of the action to execute.
processInstance
ProcessInstance
The process instance from which the action is executed. ProcessInstance
runtime
WorkflowRuntime
The runtime instance that manages the process instance. WorkflowRuntime
actionParameter
String
Additional action parameter value. ActionDefinitionReference.ActionParameter
token
CancellationToken
Cancellation token.

Returns

Type
Description
Task
A task that represents the asynchronous operation.
bool ExecuteCondition(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter) #
Executes a condition and returns the result.

Parameters

Name
Type
Description
name
String
Name of the condition to check.
processInstance
ProcessInstance
The process instance from which the condition is checked. ProcessInstance
runtime
WorkflowRuntime
The runtime instance that manages the process instance. WorkflowRuntime
actionParameter
String
Additional condition parameter value. ActionDefinitionReference.ActionParameter

Returns

Type
Description
Boolean
true if the condition evaluates to true; otherwise, false.
Task<bool> ExecuteConditionAsync(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter, CancellationToken token) #
Executes a condition asynchronously and returns the result.

Parameters

Name
Type
Description
name
String
Name of the condition to check.
processInstance
ProcessInstance
The process instance from which the condition is checked. ProcessInstance
runtime
WorkflowRuntime
The runtime instance that manages the process instance. WorkflowRuntime
actionParameter
String
Additional condition parameter value. ActionDefinitionReference.ActionParameter
token
CancellationToken
Cancellation token.

Returns

Type
Description
Task<Boolean>
A task that resolves to true if the condition evaluates to true; otherwise, false.
bool IsActionAsync(string name, string schemeCode) #
Checks whether an action should be executed asynchronously.

Parameters

Name
Type
Description
name
String
Name of the action.
schemeCode
String
Code of the scheme that the action belongs to.

Returns

Type
Description
Boolean
true if the action is asynchronous; otherwise, false.
bool IsConditionAsync(string name, string schemeCode) #
Checks whether a condition should be evaluated asynchronously.

Parameters

Name
Type
Description
name
String
Name of the condition.
schemeCode
String
Code of the scheme that the condition belongs to.

Returns

Type
Description
Boolean
true if the condition is asynchronous; otherwise, false.
List<string> GetActions(string schemeCode, NamesSearchType namesSearchType) #
Returns action names for a scheme.

Parameters

Name
Type
Description
schemeCode
String
Code of the scheme for which action names are requested.
namesSearchType
NamesSearchType
The name selection strategy.

Returns

Type
Description
List<String>
A list of action names.
List<string> GetConditions(string schemeCode, NamesSearchType namesSearchType) #
Returns condition names for a scheme.

Parameters

Name
Type
Description
schemeCode
String
Code of the scheme for which condition names are requested.
namesSearchType
NamesSearchType
The name selection strategy.

Returns

Type
Description
List<String>
A list of condition names.

Remarks

Implementations execute actions defined in ActivityDefinition.Implementation and ActivityDefinition.PreExecutionImplementation and evaluate conditions referenced by ConditionDefinition.Action.