Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Class WorkflowRuntimeGetActorsApi

OptimaJet.Workflow.Core.Runtime.WorkflowRuntimeGetActorsApi

Workflow Runtime API extension for GetActors methods

public static class WorkflowRuntimeGetActorsApi

Inheritance

  • System.Object

Methods

public static Task<IEnumerable<string>> GetAllActorsForAllCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default) #
Get the list of user ids which can execute any command for specified process activity (async version)

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance
processId
Guid
Process id
beginningWithRoot
Boolean
If true the list of actors will be obtained from the root process, even if you passed Id of the subprocess
activityName
String
Activity name in which transitions are checked. Current activity if null.
token
CancellationToken
Cancellation token

Returns

Type
Description
Task<String>
List of user ids
public static Task<IEnumerable<string>> GetAllActorsForDirectCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default) #
Get the list of user ids which can execute any command bound with direct transitions (by transition classifier) for specified process activity (async version)

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance
processId
Guid
Process id
beginningWithRoot
Boolean
If true the list of actors will be obtained from the root process, even if you passed Id of the subprocess
activityName
String
Activity name in which transitions are checked. Current activity if null.
token
CancellationToken
Cancellation token

Returns

Type
Description
Task<String>
List of user ids
public static Task<IEnumerable<string>> GetAllActorsForDirectAndUndefinedCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default) #
Get the list of user ids which can execute any command bound with direct or undefined transitions (by transition classifier) for specified process activity (async version)

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance
processId
Guid
Process id
beginningWithRoot
Boolean
If true the list of actors will be obtained from the root process, even if you passed Id of the subprocess
activityName
String
Activity name in which transitions are checked. Current activity if null.
token
CancellationToken
Cancellation token

Returns

Type
Description
Task<String>
List of user ids
public static Task<IEnumerable<string>> GetAllActorsForReverseCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default) #
Get the list of user ids which can execute any command bound with reverse transitions (by transition classifier) for specified process activity (async version)

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance
processId
Guid
Process id
beginningWithRoot
Boolean
If true the list of actors will be obtained from the root process, even if you passed Id of the subprocess
activityName
String
Activity name in which transitions are checked. Current activity if null.
token
CancellationToken
Cancellation token

Returns

Type
Description
Task<String>
List of user ids
public static Task<IEnumerable<string>> GetAllActorsForCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, List<TransitionClassifier> classifiers, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default) #
Get the list of user ids which can execute any command bound with a transitions selected by filter (by transition classifier) for specified process activity Async

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance
processId
Guid
Process id
classifiers
List<TransitionClassifier>
Filter for transitions by transition classifier
beginningWithRoot
Boolean
If true the list of actors will be obtained from the root process, even if you passed Id of the subprocess
activityName
String
Activity name in which transitions are checked. Current activity if null.
token
CancellationToken
Cancellation token

Returns

Type
Description
Task<String>
List of user ids
public static Task<IEnumerable<string>> GetAllActorsForCommandTransitionsAsync(this WorkflowRuntime runtime, ProcessInstance processInstance, List<TransitionClassifier> classifiers = null, CancellationToken token = default) #
Get the list of user ids which can execute any command bound with a transitions selected by filter (by transition classifier) for executed activity (inside of a transitional process) or for current activity (when a process is idled). (async version) Using of this method is preferable for notification of users which can execute next commands.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance
processInstance
ProcessInstance
Process instance
classifiers
List<TransitionClassifier>
Filter for transitions by transition classifier
token
CancellationToken
Cancellation token

Returns

Type
Description
Task<String>
List of user ids
public static Task<IEnumerable<string>> GetAllActorsForCommandTransitionsAsync(this WorkflowRuntime runtime, TreeSearchFilter filter, List<TransitionClassifier> classifiers = null, CancellationToken token = default) #
Get the list of user ids which can execute any command bound with a transitions selected by filter. This method is prefearable to use when you are using subprocesses (async version)

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance
filter
TreeSearchFilter
Sets the current process and the method of searching in the Process Instances tree
classifiers
List<TransitionClassifier>
Filter for transitions by transition classifier
token
CancellationToken
Cancellation token

Returns

Type
Description
Task<String>
List of user ids
public static IEnumerable<string> GetAllActorsForAllCommandTransitions(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null) #
Get the list of user ids which can execute any command for specified process activity

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance
processId
Guid
Process id
beginningWithRoot
Boolean
If true the list of actors will be obtained from the root process, even if you passed Id of the subprocess
activityName
String
Activity name in which transitions are checked. Current activity if null.

Returns

Type
Description
IEnumerable<String>
List of user ids
public static IEnumerable<string> GetAllActorsForDirectCommandTransitions(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null) #
Get the list of user ids which can execute any command bound with direct transitions (by transition classifier) for specified process activity

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance
processId
Guid
Process id
beginningWithRoot
Boolean
If true the list of actors will be obtained from the root process, even if you passed Id of the subprocess
activityName
String
Activity name in which transitions are checked. Current activity if null.

Returns

Type
Description
IEnumerable<String>
List of user ids
public static IEnumerable<string> GetAllActorsForDirectAndUndefinedCommandTransitions(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null) #
Get the list of user ids which can execute any command bound with direct or undefined transitions (by transition classifier) for specified process activity

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance
processId
Guid
Process id
beginningWithRoot
Boolean
If true the list of actors will be obtained from the root process, even if you passed Id of the subprocess
activityName
String
Activity name in which transitions are checked. Current activity if null.

Returns

Type
Description
IEnumerable<String>
List of user ids
public static IEnumerable<string> GetAllActorsForReverseCommandTransitions(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null) #
Get the list of user ids which can execute any command bound with reverse transitions (by transition classifier) for specified process activity

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance
processId
Guid
Process id
beginningWithRoot
Boolean
If true the list of actors will be obtained from the root process, even if you passed Id of the subprocess
activityName
String
Activity name in which transitions are checked. Current activity if null.

Returns

Type
Description
IEnumerable<String>
List of user ids
public static IEnumerable<string> GetAllActorsForCommandTransitions(this WorkflowRuntime runtime, Guid processId, List<TransitionClassifier> classifiers, bool beginningWithRoot = false, string activityName = null) #
Get the list of user ids which can execute any command bound with a transitions selected by filter (by transition classifier) for specified process activity

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance
processId
Guid
Process id
classifiers
List<TransitionClassifier>
Filter for transitions by transition classifier
beginningWithRoot
Boolean
If true the list of actors will be obtained from the root process, even if you passed Id of the subprocess
activityName
String
Activity name in which transitions are checked. Current activity if null.

Returns

Type
Description
IEnumerable<String>
List of user ids
public static IEnumerable<string> GetAllActorsForCommandTransitions(this WorkflowRuntime runtime, ProcessInstance processInstance, List<TransitionClassifier> classifiers = null) #
Get the list of user ids which can execute any command bound with a transitions selected by filter (by transition classifier) for executed activity (inside of a transitional process) or for current activity (when a process is idled). Using of this method is preferable for notification of users which can execute next commands.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance
processInstance
ProcessInstance
Process instance
classifiers
List<TransitionClassifier>
Filter for transitions by transition classifier

Returns

Type
Description
IEnumerable<String>
List of user ids
public static IEnumerable<string> GetAllActorsForCommandTransitions(this WorkflowRuntime runtime, TreeSearchFilter filter, List<TransitionClassifier> classifiers = null) #
Get the list of user ids which can execute any command bound with a transitions selected by filter. This method is prefearable to use when you are using subprocesses

Parameters

Name
Type
Description
runtime
WorkflowRuntime
Workflow runtime instance
filter
TreeSearchFilter
Sets the current process and the method of searching in the Process Instances tree
classifiers
List<TransitionClassifier>
Filter for transitions by transition classifier

Returns

Type
Description
IEnumerable<String>
List of user ids