Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Interface IWorkflowRuleProvider

OptimaJet.Workflow.Core.Runtime.IWorkflowRuleProvider

Interface of a rule provider, which provide rule checking and getting of a list of users which satisfies a rule TransitionDefinition.Restrictions

Namespace: OptimaJet.Workflow.Core.Runtime

public interface IWorkflowRuleProvider

Methods

List<string> GetRules(string schemeCode, NamesSearchType namesSearchType) #
Return all rule names

Parameters

Name
Type
Description
schemeCode
String
namesSearchType
NamesSearchType

Returns

Type
Description
List<String>
List of rule names
bool Check(ProcessInstance processInstance, WorkflowRuntime runtime, string identityId, string ruleName, string parameter) #
Check the rule

Parameters

Name
Type
Description
processInstance
ProcessInstance
Reference to ProcessInstance for which rule is checked ProcessInstance
runtime
WorkflowRuntime
Reference to WorkflowRuntime object which managed specified process instance WorkflowRuntime
identityId
String
User id for which rule is checking
ruleName
String
Name of the rule to check
parameter
String
Additional rule parameter RestrictionDefinition.Actor ActorDefinition.Value

Returns

Type
Description
Boolean
Rule check result
Task<bool> CheckAsync(ProcessInstance processInstance, WorkflowRuntime runtime, string identityId, string ruleName, string parameter, CancellationToken token) #
Check the rule asynchronously

Parameters

Name
Type
Description
processInstance
ProcessInstance
Reference to ProcessInstance for which rule is checked ProcessInstance
runtime
WorkflowRuntime
Reference to WorkflowRuntime object which managed specified process instance WorkflowRuntime
identityId
String
User id for which rule is checking
ruleName
String
Name of the rule to check
parameter
String
Additional rule parameter RestrictionDefinition.Actor ActorDefinition.Value
token
CancellationToken
Cancellation token to cancel the operation

Returns

Type
Description
Task<Boolean>
Rule check result
IEnumerable<string> GetIdentities(ProcessInstance processInstance, WorkflowRuntime runtime, string ruleName, string parameter) #
Get the list of users which satisfies the rule

Parameters

Name
Type
Description
processInstance
ProcessInstance
Reference to ProcessInstance for which rule is checked ProcessInstance
runtime
WorkflowRuntime
Reference to WorkflowRuntime object which managed specified process instance WorkflowRuntime
ruleName
String
Name of the rule to get users list
parameter
String
Additional rule parameter RestrictionDefinition.Actor ActorDefinition.Value

Returns

Type
Description
IEnumerable<String>
List of users which satisfies the rule
Task<IEnumerable<string>> GetIdentitiesAsync(ProcessInstance processInstance, WorkflowRuntime runtime, string ruleName, string parameter, CancellationToken token) #
Get the list of users which satisfies the rule asynchronously

Parameters

Name
Type
Description
processInstance
ProcessInstance
Reference to ProcessInstance for which rule is checked ProcessInstance
runtime
WorkflowRuntime
Reference to WorkflowRuntime object which managed specified process instance WorkflowRuntime
ruleName
String
Name of the rule to get users list
parameter
String
Additional rule parameter RestrictionDefinition.Actor ActorDefinition.Value
token
CancellationToken
Cancellation token to cancel the operation

Returns

Type
Description
Task<String>
List of users which satisfies the rule
bool IsCheckAsync(string ruleName, string schemeCode) #
Checks whether Check the rule should be called asynchronously

Parameters

Name
Type
Description
ruleName
String
Name of the action
schemeCode
String
Code of the scheme to which the rule belongs

Returns

Type
Description
Boolean
bool IsGetIdentitiesAsync(string ruleName, string schemeCode) #
Checks whether Get the list of users which satisfies the rule should be called asynchronously

Parameters

Name
Type
Description
ruleName
String
Name of the condition
schemeCode
String
Code of the scheme to which the rule belongs

Returns

Type
Description
Boolean

Derived Types