Class WorkflowRuntimeGetActorsWithCommandsApi
OptimaJet.Workflow.Core.Runtime.WorkflowRuntimeGetActorsWithCommandsApi
Provides WorkflowRuntime extension methods for resolving workflow participant identities and associated commands from actor restrictions on command transitions.
Namespace: OptimaJet.Workflow.Core.Runtime
public static class WorkflowRuntimeGetActorsWithCommandsApiMethods
public static Task<Dictionary<string, List<CommandWithClassifier>>> GetAllActorsWithCommandsForAllCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default) #Gets workflow participant identities and associated commands for command transitions of any classifier in the selected process-tree scope.
Parameters
Name
Type
Description
runtimeWorkflowRuntimeWorkflow runtime instance.
processIdGuidProcess identifier.
beginningWithRootBooleanactivityNameStringOptional activity name to inspect in each selected process. If a process has no matching activity at the same nesting level, its executed activity is inspected when available; otherwise, its current activity is inspected.
tokenCancellationTokenCancellation token.
Returns
Type
Description
Task<String, CommandWithClassifier>A dictionary keyed by workflow participant identity, where each value contains the command names and transition classifiers associated with that identity by actor restrictions.
Remarks
Transition conditions are not evaluated.
public static Task<Dictionary<string, List<CommandWithClassifier>>> GetAllActorsWithCommandsForDirectCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default) #Gets workflow participant identities and associated commands for TransitionClassifier.Direct command transitions in the selected process-tree scope.
Parameters
Name
Type
Description
runtimeWorkflowRuntimeWorkflow runtime instance.
processIdGuidProcess identifier.
beginningWithRootBooleanactivityNameStringOptional activity name to inspect in each selected process. If a process has no matching activity at the same nesting level, its executed activity is inspected when available; otherwise, its current activity is inspected.
tokenCancellationTokenCancellation token.
Returns
Type
Description
Task<String, CommandWithClassifier>A dictionary keyed by workflow participant identity, where each value contains the command names and transition classifiers associated with that identity by actor restrictions.
Remarks
Transition conditions are not evaluated.
public static Task<Dictionary<string, List<CommandWithClassifier>>> GetAllActorsWithCommandsForDirectAndUndefinedCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default) #Gets workflow participant identities and associated commands for TransitionClassifier.Direct and TransitionClassifier.NotSpecified command transitions in the selected process-tree scope.
Parameters
Name
Type
Description
runtimeWorkflowRuntimeWorkflow runtime instance.
processIdGuidProcess identifier.
beginningWithRootBooleanactivityNameStringOptional activity name to inspect in each selected process. If a process has no matching activity at the same nesting level, its executed activity is inspected when available; otherwise, its current activity is inspected.
tokenCancellationTokenCancellation token.
Returns
Type
Description
Task<String, CommandWithClassifier>A dictionary keyed by workflow participant identity, where each value contains the command names and transition classifiers associated with that identity by actor restrictions.
Remarks
Transition conditions are not evaluated.
public static Task<Dictionary<string, List<CommandWithClassifier>>> GetAllActorsWithCommandsForReverseCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default) #Gets workflow participant identities and associated commands for TransitionClassifier.Reverse command transitions in the selected process-tree scope.
Parameters
Name
Type
Description
runtimeWorkflowRuntimeWorkflow runtime instance.
processIdGuidProcess identifier.
beginningWithRootBooleanactivityNameStringOptional activity name to inspect in each selected process. If a process has no matching activity at the same nesting level, its executed activity is inspected when available; otherwise, its current activity is inspected.
tokenCancellationTokenCancellation token.
Returns
Type
Description
Task<String, CommandWithClassifier>A dictionary keyed by workflow participant identity, where each value contains the command names and transition classifiers associated with that identity by actor restrictions.
Remarks
Transition conditions are not evaluated.
public static Task<Dictionary<string, List<CommandWithClassifier>>> GetAllActorsWithCommandsForCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, List<TransitionClassifier> classifiers, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default) #Gets workflow participant identities and associated commands for command transitions that match the classifier filter in the selected process-tree scope.
Parameters
Name
Type
Description
runtimeWorkflowRuntimeWorkflow runtime instance.
processIdGuidProcess identifier.
classifiersList<TransitionClassifier>Optional transition classifier filter. If null, workflow participant identities for all transition classifiers are returned.
beginningWithRootBooleanactivityNameStringOptional activity name to inspect in each selected process. If a process has no matching activity at the same nesting level, its executed activity is inspected when available; otherwise, its current activity is inspected.
tokenCancellationTokenCancellation token.
Returns
Type
Description
Task<String, CommandWithClassifier>A dictionary keyed by workflow participant identity, where each value contains the command names and transition classifiers associated with that identity by actor restrictions.
Remarks
Transition conditions are not evaluated.
public static Task<Dictionary<string, List<CommandWithClassifier>>> GetAllActorsWithCommandsForCommandTransitionsAsync(this WorkflowRuntime runtime, ProcessInstance processInstance, List<TransitionClassifier> classifiers = null, CancellationToken token = default) #Gets workflow participant identities and associated commands for matching transitions in the specified process and its subprocesses, using each process's executed activity when available or its current activity otherwise.
Parameters
Name
Type
Description
runtimeWorkflowRuntimeWorkflow runtime instance.
processInstanceProcessInstanceProcess instance where process-tree traversal starts.
classifiersList<TransitionClassifier>Optional transition classifier filter. If null, workflow participant identities for all transition classifiers are returned.
tokenCancellationTokenCancellation token.
Returns
Type
Description
Task<String, CommandWithClassifier>A dictionary keyed by workflow participant identity, where each value contains the command names and transition classifiers associated with that identity by actor restrictions.
Remarks
Transition conditions are not evaluated.
public static Task<Dictionary<string, List<CommandWithClassifier>>> GetAllActorsWithCommandsForCommandTransitionsAsync(this WorkflowRuntime runtime, TreeSearchFilter filter, List<TransitionClassifier> classifiers = null, CancellationToken token = default) #Gets workflow participant identities and associated commands for matching transitions in the processes selected by a custom process-tree search filter.
Parameters
Name
Type
Description
runtimeWorkflowRuntimeWorkflow runtime instance.
filterTreeSearchFilterProcess tree search options.
classifiersList<TransitionClassifier>Optional transition classifier filter. If null, workflow participant identities for all transition classifiers are returned.
tokenCancellationTokenCancellation token.
Returns
Type
Description
Task<String, CommandWithClassifier>A dictionary keyed by workflow participant identity, where each value contains the command names and transition classifiers associated with that identity by actor restrictions.
Remarks
Transition conditions are not evaluated.
public static Dictionary<string, List<CommandWithClassifier>> GetAllActorsWithCommandsForAllCommandTransitions(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null) #Gets workflow participant identities and associated commands for command transitions of any classifier in the selected process-tree scope.
Parameters
Name
Type
Description
runtimeWorkflowRuntimeWorkflow runtime instance.
processIdGuidProcess identifier.
beginningWithRootBooleanactivityNameStringOptional activity name to inspect in each selected process. If a process has no matching activity at the same nesting level, its executed activity is inspected when available; otherwise, its current activity is inspected.
Returns
Type
Description
Dictionary<String, CommandWithClassifier>A dictionary keyed by workflow participant identity, where each value contains the command names and transition classifiers associated with that identity by actor restrictions.
Remarks
Transition conditions are not evaluated. This method synchronously waits for the corresponding asynchronous call.
public static Dictionary<string, List<CommandWithClassifier>> GetAllActorsWithCommandsForDirectCommandTransitions(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null) #Gets workflow participant identities and associated commands for TransitionClassifier.Direct command transitions in the selected process-tree scope.
Parameters
Name
Type
Description
runtimeWorkflowRuntimeWorkflow runtime instance.
processIdGuidProcess identifier.
beginningWithRootBooleanactivityNameStringOptional activity name to inspect in each selected process. If a process has no matching activity at the same nesting level, its executed activity is inspected when available; otherwise, its current activity is inspected.
Returns
Type
Description
Dictionary<String, CommandWithClassifier>A dictionary keyed by workflow participant identity, where each value contains the command names and transition classifiers associated with that identity by actor restrictions.
Remarks
Transition conditions are not evaluated. This method synchronously waits for the corresponding asynchronous call.
public static Dictionary<string, List<CommandWithClassifier>> GetAllActorsWithCommandsForDirectAndUndefinedCommandTransitions(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null) #Gets workflow participant identities and associated commands for TransitionClassifier.Direct and TransitionClassifier.NotSpecified command transitions in the selected process-tree scope.
Parameters
Name
Type
Description
runtimeWorkflowRuntimeWorkflow runtime instance.
processIdGuidProcess identifier.
beginningWithRootBooleanactivityNameStringOptional activity name to inspect in each selected process. If a process has no matching activity at the same nesting level, its executed activity is inspected when available; otherwise, its current activity is inspected.
Returns
Type
Description
Dictionary<String, CommandWithClassifier>A dictionary keyed by workflow participant identity, where each value contains the command names and transition classifiers associated with that identity by actor restrictions.
Remarks
Transition conditions are not evaluated. This method synchronously waits for the corresponding asynchronous call.
public static Dictionary<string, List<CommandWithClassifier>> GetAllActorsWithCommandsForReverseCommandTransitions(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null) #Gets workflow participant identities and associated commands for TransitionClassifier.Reverse command transitions in the selected process-tree scope.
Parameters
Name
Type
Description
runtimeWorkflowRuntimeWorkflow runtime instance.
processIdGuidProcess identifier.
beginningWithRootBooleanactivityNameStringOptional activity name to inspect in each selected process. If a process has no matching activity at the same nesting level, its executed activity is inspected when available; otherwise, its current activity is inspected.
Returns
Type
Description
Dictionary<String, CommandWithClassifier>A dictionary keyed by workflow participant identity, where each value contains the command names and transition classifiers associated with that identity by actor restrictions.
Remarks
Transition conditions are not evaluated. This method synchronously waits for the corresponding asynchronous call.
public static Dictionary<string, List<CommandWithClassifier>> GetAllActorsWithCommandsForCommandTransitions(this WorkflowRuntime runtime, Guid processId, List<TransitionClassifier> classifiers, bool beginningWithRoot = false, string activityName = null) #Gets workflow participant identities and associated commands for command transitions that match the classifier filter in the selected process-tree scope.
Parameters
Name
Type
Description
runtimeWorkflowRuntimeWorkflow runtime instance.
processIdGuidProcess identifier.
classifiersList<TransitionClassifier>Optional transition classifier filter. If null, workflow participant identities for all transition classifiers are returned.
beginningWithRootBooleanactivityNameStringOptional activity name to inspect in each selected process. If a process has no matching activity at the same nesting level, its executed activity is inspected when available; otherwise, its current activity is inspected.
Returns
Type
Description
Dictionary<String, CommandWithClassifier>A dictionary keyed by workflow participant identity, where each value contains the command names and transition classifiers associated with that identity by actor restrictions.
Remarks
Transition conditions are not evaluated. This method synchronously waits for the corresponding asynchronous call.
public static Dictionary<string, List<CommandWithClassifier>> GetAllActorsWithCommandsForCommandTransitions(this WorkflowRuntime runtime, ProcessInstance processInstance, List<TransitionClassifier> classifiers = null) #Gets workflow participant identities and associated commands for matching transitions in the specified process and its subprocesses, using each process's executed activity when available or its current activity otherwise.
Parameters
Name
Type
Description
runtimeWorkflowRuntimeWorkflow runtime instance.
processInstanceProcessInstanceProcess instance where process-tree traversal starts.
classifiersList<TransitionClassifier>Optional transition classifier filter. If null, workflow participant identities for all transition classifiers are returned.
Returns
Type
Description
Dictionary<String, CommandWithClassifier>A dictionary keyed by workflow participant identity, where each value contains the command names and transition classifiers associated with that identity by actor restrictions.
Remarks
Transition conditions are not evaluated. This method synchronously waits for the corresponding asynchronous call.
public static Dictionary<string, List<CommandWithClassifier>> GetAllActorsWithCommandsForCommandTransitions(this WorkflowRuntime runtime, TreeSearchFilter filter, List<TransitionClassifier> classifiers = null) #Gets workflow participant identities and associated commands for matching transitions in the processes selected by a custom process-tree search filter.
Parameters
Name
Type
Description
runtimeWorkflowRuntimeWorkflow runtime instance.
filterTreeSearchFilterProcess tree search options.
classifiersList<TransitionClassifier>Optional transition classifier filter. If null, workflow participant identities for all transition classifiers are returned.
Returns
Type
Description
Dictionary<String, CommandWithClassifier>A dictionary keyed by workflow participant identity, where each value contains the command names and transition classifiers associated with that identity by actor restrictions.
Remarks
Transition conditions are not evaluated. This method synchronously waits for the corresponding asynchronous call.