Assembly: OptimaJet.Workflow.Core

Class WorkflowRuntimeGetActorsApi

OptimaJet.Workflow.Core.Runtime.WorkflowRuntimeGetActorsApi

Provides extension methods on WorkflowRuntime for resolving workflow participant identities assigned to command transitions by actor restrictions.

public static class WorkflowRuntimeGetActorsApi

Methods

public static Task<IEnumerable<string>> GetAllActorsForAllCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default) #
Gets workflow participant identities assigned to command transitions of any classifier in the selected process-tree scope.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance.
processId
Guid
Process identifier.
beginningWithRoot
Boolean
If false, searches the specified process and its subprocesses. If true, searches the root process and its complete subprocess tree.
activityName
String
Optional 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.
token
CancellationToken
Cancellation token.

Returns

Type
Description
Task<String>
Distinct workflow participant identities resolved from applicable actor restrictions.

Remarks

Transition conditions are not evaluated.
public static Task<IEnumerable<string>> GetAllActorsForDirectCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default) #
Gets workflow participant identities assigned to TransitionClassifier.Direct command transitions in the selected process-tree scope.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance.
processId
Guid
Process identifier.
beginningWithRoot
Boolean
If false, searches the specified process and its subprocesses. If true, searches the root process and its complete subprocess tree.
activityName
String
Optional 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.
token
CancellationToken
Cancellation token.

Returns

Type
Description
Task<String>
Distinct workflow participant identities resolved from applicable actor restrictions.

Remarks

Transition conditions are not evaluated.
public static Task<IEnumerable<string>> GetAllActorsForDirectAndUndefinedCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default) #
Gets workflow participant identities assigned to TransitionClassifier.Direct or TransitionClassifier.NotSpecified command transitions in the selected process-tree scope.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance.
processId
Guid
Process identifier.
beginningWithRoot
Boolean
If false, searches the specified process and its subprocesses. If true, searches the root process and its complete subprocess tree.
activityName
String
Optional 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.
token
CancellationToken
Cancellation token.

Returns

Type
Description
Task<String>
Distinct workflow participant identities resolved from applicable actor restrictions.

Remarks

Transition conditions are not evaluated.
public static Task<IEnumerable<string>> GetAllActorsForReverseCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default) #
Gets workflow participant identities assigned to TransitionClassifier.Reverse command transitions in the selected process-tree scope.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance.
processId
Guid
Process identifier.
beginningWithRoot
Boolean
If false, searches the specified process and its subprocesses. If true, searches the root process and its complete subprocess tree.
activityName
String
Optional 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.
token
CancellationToken
Cancellation token.

Returns

Type
Description
Task<String>
Distinct workflow participant identities resolved from applicable actor restrictions.

Remarks

Transition conditions are not evaluated.
public static Task<IEnumerable<string>> GetAllActorsForCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, List<TransitionClassifier> classifiers, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default) #
Gets workflow participant identities assigned to command transitions that match the classifier filter in the selected process-tree scope.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance.
processId
Guid
Process identifier.
classifiers
List<TransitionClassifier>
Optional transition classifier filter. If null, workflow participant identities for all transition classifiers are returned.
beginningWithRoot
Boolean
If false, searches the specified process and its subprocesses. If true, searches the root process and its complete subprocess tree.
activityName
String
Optional 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.
token
CancellationToken
Cancellation token.

Returns

Type
Description
Task<String>
Distinct workflow participant identities resolved from applicable actor restrictions.

Remarks

Transition conditions are not evaluated.
public static Task<IEnumerable<string>> GetAllActorsForCommandTransitionsAsync(this WorkflowRuntime runtime, ProcessInstance processInstance, List<TransitionClassifier> classifiers = null, CancellationToken token = default) #
Gets workflow participant identities assigned to matching command 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
runtime
WorkflowRuntime
Workflow runtime instance.
processInstance
ProcessInstance
Process instance where process-tree traversal starts.
classifiers
List<TransitionClassifier>
Optional transition classifier filter. If null, workflow participant identities for all transition classifiers are returned.
token
CancellationToken
Cancellation token.

Returns

Type
Description
Task<String>
Distinct workflow participant identities resolved from applicable actor restrictions.

Remarks

Transition conditions are not evaluated.
public static Task<IEnumerable<string>> GetAllActorsForCommandTransitionsAsync(this WorkflowRuntime runtime, TreeSearchFilter filter, List<TransitionClassifier> classifiers = null, CancellationToken token = default) #
Gets workflow participant identities assigned to matching command transitions in the processes selected by a custom process-tree search filter.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance.
filter
TreeSearchFilter
Search options that define the process scope and tree traversal strategy.
classifiers
List<TransitionClassifier>
Optional transition classifier filter. If null, workflow participant identities for all transition classifiers are returned.
token
CancellationToken
Cancellation token.

Returns

Type
Description
Task<String>
Distinct workflow participant identities resolved from applicable actor restrictions.

Remarks

Transition conditions are not evaluated.
public static IEnumerable<string> GetAllActorsForAllCommandTransitions(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null) #
Gets workflow participant identities assigned to command transitions of any classifier in the selected process-tree scope.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance.
processId
Guid
Process identifier.
beginningWithRoot
Boolean
If false, searches the specified process and its subprocesses. If true, searches the root process and its complete subprocess tree.
activityName
String
Optional 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
IEnumerable<String>
Distinct workflow participant identities resolved from applicable actor restrictions.

Remarks

Transition conditions are not evaluated. This method synchronously waits for the corresponding asynchronous call.
public static IEnumerable<string> GetAllActorsForDirectCommandTransitions(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null) #
Gets workflow participant identities assigned to TransitionClassifier.Direct command transitions in the selected process-tree scope.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance.
processId
Guid
Process identifier.
beginningWithRoot
Boolean
If false, searches the specified process and its subprocesses. If true, searches the root process and its complete subprocess tree.
activityName
String
Optional 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
IEnumerable<String>
Distinct workflow participant identities resolved from applicable actor restrictions.

Remarks

Transition conditions are not evaluated. This method synchronously waits for the corresponding asynchronous call.
public static IEnumerable<string> GetAllActorsForDirectAndUndefinedCommandTransitions(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null) #
Gets workflow participant identities assigned to TransitionClassifier.Direct or TransitionClassifier.NotSpecified command transitions in the selected process-tree scope.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance.
processId
Guid
Process identifier.
beginningWithRoot
Boolean
If false, searches the specified process and its subprocesses. If true, searches the root process and its complete subprocess tree.
activityName
String
Optional 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
IEnumerable<String>
Distinct workflow participant identities resolved from applicable actor restrictions.

Remarks

Transition conditions are not evaluated. This method synchronously waits for the corresponding asynchronous call.
public static IEnumerable<string> GetAllActorsForReverseCommandTransitions(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null) #
Gets workflow participant identities assigned to TransitionClassifier.Reverse command transitions in the selected process-tree scope.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance.
processId
Guid
Process identifier.
beginningWithRoot
Boolean
If false, searches the specified process and its subprocesses. If true, searches the root process and its complete subprocess tree.
activityName
String
Optional 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
IEnumerable<String>
Distinct workflow participant identities resolved from applicable actor restrictions.

Remarks

Transition conditions are not evaluated. This method synchronously waits for the corresponding asynchronous call.
public static IEnumerable<string> GetAllActorsForCommandTransitions(this WorkflowRuntime runtime, Guid processId, List<TransitionClassifier> classifiers, bool beginningWithRoot = false, string activityName = null) #
Gets workflow participant identities assigned to command transitions that match the classifier filter in the selected process-tree scope.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance.
processId
Guid
Process identifier.
classifiers
List<TransitionClassifier>
Optional transition classifier filter. If null, workflow participant identities for all transition classifiers are returned.
beginningWithRoot
Boolean
If false, searches the specified process and its subprocesses. If true, searches the root process and its complete subprocess tree.
activityName
String
Optional 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
IEnumerable<String>
Distinct workflow participant identities resolved from applicable actor restrictions.

Remarks

Transition conditions are not evaluated. This method synchronously waits for the corresponding asynchronous call.
public static IEnumerable<string> GetAllActorsForCommandTransitions(this WorkflowRuntime runtime, ProcessInstance processInstance, List<TransitionClassifier> classifiers = null) #
Gets workflow participant identities assigned to matching command 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
runtime
WorkflowRuntime
Workflow runtime instance.
processInstance
ProcessInstance
Process instance where process-tree traversal starts.
classifiers
List<TransitionClassifier>
Optional transition classifier filter. If null, workflow participant identities for all transition classifiers are returned.

Returns

Type
Description
IEnumerable<String>
Distinct workflow participant identities resolved from applicable actor restrictions.

Remarks

Transition conditions are not evaluated. This method synchronously waits for the corresponding asynchronous call.
public static IEnumerable<string> GetAllActorsForCommandTransitions(this WorkflowRuntime runtime, TreeSearchFilter filter, List<TransitionClassifier> classifiers = null) #
Gets workflow participant identities assigned to matching command transitions in the processes selected by a custom process-tree search filter.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance.
filter
TreeSearchFilter
Search options that define the process scope and tree traversal strategy.
classifiers
List<TransitionClassifier>
Optional transition classifier filter. If null, workflow participant identities for all transition classifiers are returned.

Returns

Type
Description
IEnumerable<String>
Distinct workflow participant identities resolved from applicable actor restrictions.

Remarks

Transition conditions are not evaluated. This method synchronously waits for the corresponding asynchronous call.