Class AggregatingActionProvider
OptimaJet.Workflow.Core.Runtime.AggregatingActionProvider
Combines registered IWorkflowActionProvider implementations into one provider and resolves duplicate action and condition names by registration priority.
Namespace: OptimaJet.Workflow.Core.Runtime
public class AggregatingActionProvider : BaseAggregatingProvider<IWorkflowActionProvider>, IWorkflowActionProviderType Hierarchy
- BaseAggregatingProvider<IWorkflowActionProvider>
- AggregatingActionProvider Current type
- Implemented interfaces
- AggregatingActionProvider Current type
Methods
public void ExecuteAction(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter) #Executes an action.
Parameters
Name
Type
Description
nameStringName of the action to execute.
processInstanceProcessInstanceThe process instance from which the action is executed. ProcessInstance
Exceptions
Type
Description
NotImplementedExceptionThrown when no applicable provider advertises the action or when the owning provider reports it as asynchronous.
Remarks
The effective scheme code is obtained from
processInstance. The call is forwarded to the owning provider only when that provider reports the action as synchronous.public Task ExecuteActionAsync(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter, CancellationToken token) #Executes an action asynchronously.
Parameters
Name
Type
Description
nameStringName of the action to execute.
processInstanceProcessInstanceThe process instance from which the action is executed. ProcessInstance
tokenCancellationTokenCancellation token.
Returns
Type
Description
TaskA task that represents the asynchronous operation.
Exceptions
Type
Description
NotImplementedExceptionThrown when no applicable provider advertises the action or when the owning provider reports it as synchronous.
Remarks
The effective scheme code is obtained from
processInstance. The call is forwarded to the owning provider only when that provider reports the action as asynchronous.public bool ExecuteCondition(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter) #Executes a condition and returns the result.
Parameters
Name
Type
Description
nameStringName of the condition to check.
processInstanceProcessInstanceThe process instance from which the condition is checked. ProcessInstance
actionParameterStringAdditional condition parameter value. ActionDefinitionReference.ActionParameter
Returns
Exceptions
Type
Description
NotImplementedExceptionThrown when no applicable provider advertises the condition or when the owning provider reports it as asynchronous.
Remarks
The effective scheme code is obtained from
processInstance. The call is forwarded to the owning provider only when that provider reports the condition as synchronous.public 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
nameStringName of the condition to check.
processInstanceProcessInstanceThe process instance from which the condition is checked. ProcessInstance
actionParameterStringAdditional condition parameter value. ActionDefinitionReference.ActionParameter
tokenCancellationTokenCancellation token.
Returns
Type
Description
Exceptions
Type
Description
NotImplementedExceptionThrown when no applicable provider advertises the condition or when the owning provider reports it as synchronous.
Remarks
The effective scheme code is obtained from
processInstance. The call is forwarded to the owning provider only when that provider reports the condition as asynchronous.public bool IsActionAsync(string name, string schemeCode) #Checks whether an action should be executed asynchronously.
Parameters
Name
Type
Description
nameStringName of the action.
schemeCodeStringCode of the scheme that the action belongs to.
Returns
Exceptions
Type
Description
NotImplementedExceptionThrown when no applicable provider advertises the action.
Remarks
Returns the value reported by the most recently registered applicable provider that advertises the action.
public bool IsConditionAsync(string name, string schemeCode) #Checks whether a condition should be evaluated asynchronously.
Parameters
Name
Type
Description
nameStringName of the condition.
schemeCodeStringCode of the scheme that the condition belongs to.
Returns
Exceptions
Type
Description
NotImplementedExceptionThrown when no applicable provider advertises the condition.
Remarks
Returns the value reported by the most recently registered applicable provider that advertises the condition.
public List<string> GetActions(string schemeCode, NamesSearchType namesSearchType) #Returns action names for a scheme.
Parameters
Name
Type
Description
schemeCodeStringCode of the scheme for which action names are requested.
namesSearchTypeNamesSearchTypeThe name selection strategy.
Returns
Type
Description
List<String>A list of action names.
Remarks
Providers are queried from earliest to latest registration, and
namesSearchType is passed through unchanged. When a name occurs more than once, its first occurrence is retained.public List<string> GetConditions(string schemeCode, NamesSearchType namesSearchType) #Returns condition names for a scheme.
Parameters
Name
Type
Description
schemeCodeStringCode of the scheme for which condition names are requested.
namesSearchTypeNamesSearchTypeThe name selection strategy.
Returns
Type
Description
List<String>A list of condition names.
Remarks
Providers are queried from earliest to latest registration, and
namesSearchType is passed through unchanged. When a name occurs more than once, its first occurrence is retained.Remarks
For a scheme, both global providers and providers registered specifically for that scheme are applicable. Providers are searched from the most recently registered to the earliest, regardless of registration scope. The first provider that advertises an action or condition name owns that name.
The owning provider also determines whether the operation is synchronous or asynchronous. Calling the opposite execution method throws NotImplementedException; the aggregator does not fall back to an older provider that advertises the same name in the requested execution mode.
AggregatingActionProvider.GetActions(string, NamesSearchType) and AggregatingActionProvider.GetConditions(string, NamesSearchType) are catalog operations rather than dispatch operations. They combine names from every applicable provider in earliest-to-latest registration order and remove duplicates, so their result order does not represent dispatch priority.