Interface IWorkflowActionProvider

Interface of a action provider, which provide execution of actions specified in activities ActivityDefinition.Implementation and ActivityDefinition.PreExecutionImplementation and execution of conditions ConditionDefinition.Action

Namespace: OptimaJet.Workflow.Core.Runtime

Assembly: OptimaJet.Workflow.Core.dll

Syntax

public interface IWorkflowActionProvider

Methods

ExecuteAction(string, ProcessInstance, WorkflowRuntime, string)

Execute action

Declaration

void ExecuteAction(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter)

Parameters

Type	Name	Description
string	name	Name of the action to execute
ProcessInstance	processInstance	Reference to ProcessInstance from which action is executed <xref href="OptimaJet.Workflow.Core.Model.ProcessInstance" data-throw-if-not-resolved="false"></xref>
WorkflowRuntime	runtime	Reference to WorkflowRuntime object which managed specified process instance <xref href="OptimaJet.Workflow.Core.Runtime.WorkflowRuntime" data-throw-if-not-resolved="false"></xref>
string	actionParameter	Additional action parameter <xref href="OptimaJet.Workflow.Core.Model.ActionDefinitionReference.ActionParameter" data-throw-if-not-resolved="false"></xref>

ExecuteActionAsync(string, ProcessInstance, WorkflowRuntime, string, CancellationToken)

Execute action asynchronously

Declaration

Task ExecuteActionAsync(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter, CancellationToken token)

Parameters

Type	Name	Description
string	name	Name of the action to execute
ProcessInstance	processInstance	Reference to ProcessInstance from which action is executed <xref href="OptimaJet.Workflow.Core.Model.ProcessInstance" data-throw-if-not-resolved="false"></xref>
WorkflowRuntime	runtime	Reference to WorkflowRuntime object which managed specified process instance <xref href="OptimaJet.Workflow.Core.Runtime.WorkflowRuntime" data-throw-if-not-resolved="false"></xref>
string	actionParameter	Additional action parameter <xref href="OptimaJet.Workflow.Core.Model.ActionDefinitionReference.ActionParameter" data-throw-if-not-resolved="false"></xref>
CancellationToken	token	Cancellation token

Returns

Type	Description
Task

ExecuteCondition(string, ProcessInstance, WorkflowRuntime, string)

Check condition

Declaration

bool ExecuteCondition(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter)

Parameters

Type	Name	Description
string	name	Name of the condition to check
ProcessInstance	processInstance	Reference to ProcessInstance from which condition is checked <xref href="OptimaJet.Workflow.Core.Model.ProcessInstance" data-throw-if-not-resolved="false"></xref>
WorkflowRuntime	runtime	Reference to WorkflowRuntime object which managed specified process instance <xref href="OptimaJet.Workflow.Core.Runtime.WorkflowRuntime" data-throw-if-not-resolved="false"></xref>
string	actionParameter	Additional action parameter <xref href="OptimaJet.Workflow.Core.Model.ActionDefinitionReference.ActionParameter" data-throw-if-not-resolved="false"></xref>

Returns

Type	Description
bool	Condition result

ExecuteConditionAsync(string, ProcessInstance, WorkflowRuntime, string, CancellationToken)

Check condition asynchronously

Declaration

Task<bool> ExecuteConditionAsync(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter, CancellationToken token)

Parameters

Type	Name	Description
string	name	Name of the condition to check
ProcessInstance	processInstance	Reference to ProcessInstance from which condition is checked <xref href="OptimaJet.Workflow.Core.Model.ProcessInstance" data-throw-if-not-resolved="false"></xref>
WorkflowRuntime	runtime	Reference to WorkflowRuntime object which managed specified process instance <xref href="OptimaJet.Workflow.Core.Runtime.WorkflowRuntime" data-throw-if-not-resolved="false"></xref>
string	actionParameter	Additional action parameter <xref href="OptimaJet.Workflow.Core.Model.ActionDefinitionReference.ActionParameter" data-throw-if-not-resolved="false"></xref>
CancellationToken	token	Cancellation token

Returns

Type	Description
Task<bool>	Condition result

IsActionAsync(string, string)

Checks whether the action should be called asynchronously

Declaration

bool IsActionAsync(string name, string schemeCode)

Parameters

Type	Name	Description
string	name	Name of the action
string	schemeCode	Scheme code

Returns

Type	Description
bool

IsConditionAsync(string, string)

Checks whether the condition should be called asynchronously

Declaration

bool IsConditionAsync(string name, string schemeCode)

Parameters

Type	Name	Description
string	name	Name of the condition
string	schemeCode	Scheme code

Returns

Type	Description
bool

GetActions(string, NamesSearchType)

Return all user actions names

Declaration

List<string> GetActions(string schemeCode, NamesSearchType namesSearchType)

Parameters

Type	Name	Description
string	schemeCode	Scheme code
NamesSearchType	namesSearchType

Returns

Type	Description
List<string>	List of actions names

GetConditions(string, NamesSearchType)

Return all user conditions names

Declaration

List<string> GetConditions(string schemeCode, NamesSearchType namesSearchType)

Parameters

Type	Name	Description
string	schemeCode	Scheme code
NamesSearchType	namesSearchType

Returns

Type	Description
List<string>	List of conditions names

Extension Methods

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