Class AggregatingExternalParametersProvider
OptimaJet.Workflow.Core.Runtime.AggregatingExternalParametersProvider
Combines registered IWorkflowExternalParametersProvider implementations into one provider and routes external parameter operations by parameter ownership and access mode.
Namespace: OptimaJet.Workflow.Core.Runtime
public class AggregatingExternalParametersProvider : BaseAggregatingProvider<IWorkflowExternalParametersProvider>, IWorkflowExternalParametersProviderType Hierarchy
- BaseAggregatingProvider<IWorkflowExternalParametersProvider>
- AggregatingExternalParametersProvider Current type
- Implemented interfaces
- AggregatingExternalParametersProvider Current type
Methods
public Task<object> GetExternalParameterAsync(string parameterName, ProcessInstance processInstance) #Gets the value of the named external parameter asynchronously.
Parameters
Name
Type
Description
parameterNameStringThe external parameter name.
processInstanceProcessInstanceThe workflow process instance for which the parameter is requested.
Returns
Type
Description
Task<Object>The asynchronous result containing the external parameter value.
Exceptions
Type
Description
NotImplementedExceptionThrown synchronously when no applicable provider both recognizes the parameter and reports asynchronous reads.
Remarks
The runtime calls this method when IWorkflowExternalParametersProvider.IsGetExternalParameterAsync(string, string, ProcessInstance) is true for the same parameter and scheme combination.
public object GetExternalParameter(string parameterName, ProcessInstance processInstance) #Gets the value of the named external parameter synchronously.
Parameters
Name
Type
Description
parameterNameStringThe external parameter name.
processInstanceProcessInstanceThe workflow process instance for which the parameter is requested.
Returns
Type
Description
ObjectThe external parameter value.
Exceptions
Type
Description
NotImplementedExceptionThrown when no applicable provider both recognizes the parameter and reports synchronous reads.
Remarks
The runtime calls this method when IWorkflowExternalParametersProvider.IsGetExternalParameterAsync(string, string, ProcessInstance) is false for the same parameter and scheme combination.
public Task SetExternalParameterAsync(string parameterName, object parameterValue, ProcessInstance processInstance) #Writes the named external parameter value asynchronously.
Parameters
Name
Type
Description
parameterNameStringThe external parameter name.
parameterValueObjectThe value to write.
processInstanceProcessInstanceThe workflow process instance for which the parameter is updated.
Returns
Type
Description
TaskA task that completes when the parameter value is written.
Exceptions
Type
Description
NotImplementedExceptionThrown synchronously when no applicable provider both recognizes the parameter and reports asynchronous writes.
Remarks
The runtime calls this method when IWorkflowExternalParametersProvider.IsSetExternalParameterAsync(string, string, ProcessInstance) is true for the same parameter and scheme combination.
public void SetExternalParameter(string parameterName, object parameterValue, ProcessInstance processInstance) #Writes the named external parameter value synchronously.
Parameters
Name
Type
Description
parameterNameStringThe external parameter name.
parameterValueObjectThe value to write.
processInstanceProcessInstanceThe workflow process instance for which the parameter is updated.
Exceptions
Type
Description
NotImplementedExceptionThrown when no applicable provider both recognizes the parameter and reports synchronous writes.
Remarks
The runtime calls this method when IWorkflowExternalParametersProvider.IsSetExternalParameterAsync(string, string, ProcessInstance) is false for the same parameter and scheme combination.
public bool IsGetExternalParameterAsync(string parameterName, string schemeCode, ProcessInstance processInstance) #Checks whether asynchronous external-parameter reads are supported for the named parameter.
Parameters
Name
Type
Description
parameterNameStringThe external parameter name.
schemeCodeStringThe scheme code for provider selection.
processInstanceProcessInstanceThe workflow process instance used for context checks.
Returns
Type
Description
BooleanRemarks
Providers are queried from most recently registered to earliest until one returns true. This method does not call IWorkflowExternalParametersProvider.HasExternalParameter(string, string, ProcessInstance).
public bool IsSetExternalParameterAsync(string parameterName, string schemeCode, ProcessInstance processInstance) #Checks whether asynchronous external-parameter writes are supported for the named parameter.
Parameters
Name
Type
Description
parameterNameStringThe external parameter name.
schemeCodeStringThe scheme code for provider selection.
processInstanceProcessInstanceThe workflow process instance used for context checks.
Returns
Type
Description
BooleanRemarks
Providers are queried from most recently registered to earliest until one returns true. This method does not call IWorkflowExternalParametersProvider.HasExternalParameter(string, string, ProcessInstance).
public bool HasExternalParameter(string parameterName, string schemeCode, ProcessInstance processInstance) #Checks whether the named external parameter exists in this provider for the scheme and process context.
Parameters
Name
Type
Description
parameterNameStringThe external parameter name.
schemeCodeStringThe scheme code for provider selection.
processInstanceProcessInstanceThe workflow process instance used for context checks.
Returns
Type
Description
Booleantrue if the parameter is recognized by the provider.
Remarks
Providers are queried from most recently registered to earliest until one returns true.
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. A read or write is forwarded to the first provider that recognizes the parameter and whose synchronous or asynchronous mode matches the method being called. Providers with a different access mode are skipped.
AggregatingExternalParametersProvider.HasExternalParameter(string, string, ProcessInstance), AggregatingExternalParametersProvider.IsGetExternalParameterAsync(string, string, ProcessInstance), and AggregatingExternalParametersProvider.IsSetExternalParameterAsync(string, string, ProcessInstance) are aggregate queries: each returns true when any applicable provider returns true. The asynchronous-mode queries do not first require the same provider to report that it recognizes the parameter.