Class AggregatingRuleProvider
OptimaJet.Workflow.Core.Runtime.AggregatingRuleProvider
Combines registered IWorkflowRuleProvider implementations into one provider and resolves duplicate rule names by registration priority.
Namespace: OptimaJet.Workflow.Core.Runtime
public class AggregatingRuleProvider : BaseAggregatingProvider<IWorkflowRuleProvider>, IWorkflowRuleProviderType Hierarchy
- BaseAggregatingProvider<IWorkflowRuleProvider>
- AggregatingRuleProvider Current type
- Implemented interfaces
- AggregatingRuleProvider Current type
Methods
public List<string> GetRules(string schemeCode, NamesSearchType namesSearchType) #Gets the rule names implemented by this provider for a process scheme.
Parameters
Name
Type
Description
schemeCodeStringThe effective process scheme code used to resolve scheme-specific rules, or null when the caller has no process scheme context.
namesSearchTypeNamesSearchTypeThe filtering mode. NamesSearchType.All includes rules excluded by provider-specific exclusion settings and is used for runtime rule resolution. NamesSearchType.NotExcluded omits those rules, for example when the Designer builds its list of available rules.
Returns
Type
Description
List<String>A non-null list of rule names implemented by this provider for the requested scheme and filtering mode.
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 bool Check(ProcessInstance processInstance, WorkflowRuntime runtime, string identityId, string ruleName, string parameter) #Determines whether a workflow participant identity satisfies a rule.
Parameters
Name
Type
Description
processInstanceProcessInstanceThe process instance whose state and parameters provide the evaluation context.
runtimeWorkflowRuntimeThe workflow runtime executing the evaluation.
identityIdStringThe application-defined value identifying the workflow participant to evaluate, such as a login, user name, database identifier, or another identifier understood by the provider.
ruleNameStringThe name of a rule advertised by IWorkflowRuleProvider.GetRules(string, NamesSearchType).
parameterStringThe provider-defined rule parameter. During standard restriction evaluation, this is the value from ActorDefinition.Value after workflow substitutions have been applied.
Returns
Exceptions
Type
Description
NotImplementedExceptionThrown when no applicable provider advertises the rule or when the owning provider reports rule checking as asynchronous.
Remarks
The runtime calls this method when IWorkflowRuleProvider.IsCheckAsync(string, string) returns false for the same rule and scheme.
public virtual Task<bool> CheckAsync(ProcessInstance processInstance, WorkflowRuntime runtime, string identityId, string ruleName, string parameter, CancellationToken token) #Asynchronously determines whether a workflow participant identity satisfies a rule.
Parameters
Name
Type
Description
processInstanceProcessInstanceThe process instance whose state and parameters provide the evaluation context.
runtimeWorkflowRuntimeThe workflow runtime executing the evaluation.
identityIdStringThe application-defined value identifying the workflow participant to evaluate, such as a login, user name, database identifier, or another identifier understood by the provider.
ruleNameStringThe name of a rule advertised by IWorkflowRuleProvider.GetRules(string, NamesSearchType).
parameterStringThe provider-defined rule parameter. During standard restriction evaluation, this is the value from ActorDefinition.Value after workflow substitutions have been applied.
tokenCancellationTokenThe token supplied by the current workflow operation to observe cancellation.
Returns
Type
Description
Exceptions
Type
Description
NotImplementedExceptionThrown when no applicable provider advertises the rule or when the owning provider reports rule checking as synchronous.
Remarks
The runtime calls this method when IWorkflowRuleProvider.IsCheckAsync(string, string) returns true for the same rule and scheme.
public IEnumerable<string> GetIdentities(ProcessInstance processInstance, WorkflowRuntime runtime, string ruleName, string parameter) #Gets all workflow participant identities that satisfy a rule.
Parameters
Name
Type
Description
processInstanceProcessInstanceThe process instance whose state and parameters provide the lookup context.
runtimeWorkflowRuntimeThe workflow runtime executing the lookup.
ruleNameStringThe name of a rule advertised by IWorkflowRuleProvider.GetRules(string, NamesSearchType).
parameterStringThe provider-defined rule parameter. During standard actor calculation, this is the value from ActorDefinition.Value after workflow substitutions have been applied.
Returns
Type
Description
IEnumerable<String>A non-null sequence of application-defined workflow participant identities. Each value must use the same identity representation accepted by IWorkflowRuleProvider.Check(ProcessInstance, WorkflowRuntime, string, string, string).
Exceptions
Type
Description
NotImplementedExceptionThrown when no applicable provider advertises the rule or when the owning provider reports workflow participant identity lookup as asynchronous.
Remarks
The runtime calls this method when IWorkflowRuleProvider.IsGetIdentitiesAsync(string, string) returns false for the same rule and scheme.
public virtual Task<IEnumerable<string>> GetIdentitiesAsync(ProcessInstance processInstance, WorkflowRuntime runtime, string ruleName, string parameter, CancellationToken token) #Asynchronously gets all workflow participant identities that satisfy a rule.
Parameters
Name
Type
Description
processInstanceProcessInstanceThe process instance whose state and parameters provide the lookup context.
runtimeWorkflowRuntimeThe workflow runtime executing the lookup.
ruleNameStringThe name of a rule advertised by IWorkflowRuleProvider.GetRules(string, NamesSearchType).
parameterStringThe provider-defined rule parameter. During standard actor calculation, this is the value from ActorDefinition.Value after workflow substitutions have been applied.
tokenCancellationTokenThe token supplied by the current workflow operation to observe cancellation.
Returns
Type
Description
Task<String>A task whose result is a non-null sequence of application-defined workflow participant identities. Each value must use the same identity representation accepted by IWorkflowRuleProvider.Check(ProcessInstance, WorkflowRuntime, string, string, string).
Exceptions
Type
Description
NotImplementedExceptionThrown when no applicable provider advertises the rule or when the owning provider reports workflow participant identity lookup as synchronous.
Remarks
The runtime calls this method when IWorkflowRuleProvider.IsGetIdentitiesAsync(string, string) returns true for the same rule and scheme.
public bool IsCheckAsync(string ruleName, string schemeCode) #Indicates whether the runtime should call IWorkflowRuleProvider.CheckAsync(ProcessInstance, WorkflowRuntime, string, string, string, CancellationToken) instead of IWorkflowRuleProvider.Check(ProcessInstance, WorkflowRuntime, string, string, string) for a rule.
Parameters
Name
Type
Description
ruleNameStringThe name of a rule advertised by IWorkflowRuleProvider.GetRules(string, NamesSearchType).
schemeCodeStringThe effective process scheme code used to resolve the rule.
Returns
Type
Description
Exceptions
Type
Description
NotImplementedExceptionThrown when the rule is not implemented for the given scheme.
Remarks
This choice is independent of the identity lookup mode returned by IWorkflowRuleProvider.IsGetIdentitiesAsync(string, string).
public bool IsGetIdentitiesAsync(string ruleName, string schemeCode) #Indicates whether the runtime should call IWorkflowRuleProvider.GetIdentitiesAsync(ProcessInstance, WorkflowRuntime, string, string, CancellationToken) instead of IWorkflowRuleProvider.GetIdentities(ProcessInstance, WorkflowRuntime, string, string) for a rule.
Parameters
Name
Type
Description
ruleNameStringThe name of a rule advertised by IWorkflowRuleProvider.GetRules(string, NamesSearchType).
schemeCodeStringThe effective process scheme code used to resolve the rule.
Returns
Type
Description
Exceptions
Type
Description
NotImplementedExceptionThrown when the rule is not implemented for the given scheme.
Remarks
This choice is independent of the rule-checking mode returned by IWorkflowRuleProvider.IsCheckAsync(string, string).
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 a rule name owns that name.
The owning provider independently determines whether rule checking and workflow participant identity lookup are synchronous or asynchronous. Calling the opposite method throws NotImplementedException; the aggregator does not fall back to an older provider that advertises the same rule in the requested execution mode.
AggregatingRuleProvider.GetRules(string, NamesSearchType) is a catalog operation rather than a dispatch operation. It combines names from every applicable provider in earliest-to-latest registration order and removes duplicates, so its result order does not represent dispatch priority.