Class EmptyWorkflowExternalParametersProvider
OptimaJet.Workflow.Core.Runtime.EmptyWorkflowExternalParametersProvider
Provides the empty fallback implementation of IWorkflowExternalParametersProvider, representing the absence of configured external parameters.
Namespace: OptimaJet.Workflow.Core.Runtime
public class EmptyWorkflowExternalParametersProvider : IWorkflowExternalParametersProviderType Hierarchy
- EmptyWorkflowExternalParametersProvider Current type
- Implemented interfaces
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
NotImplementedExceptionAlways thrown because the provider has no external parameters to read.
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
NotImplementedExceptionAlways thrown because the provider has no external parameters to read.
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
NotImplementedExceptionAlways thrown because the provider has no external parameters to write.
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
NotImplementedExceptionAlways thrown because the provider has no external parameters to write.
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
Booleanpublic 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
Booleanpublic 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
The provider reports that every external parameter is unavailable and that asynchronous access is unsupported. The runtime therefore does not normally call its read or write methods. Calling any read or write method directly throws NotImplementedException synchronously.