Class WorkflowRuntimeGetActorsApi

Workflow Runtime API extension for GetActors methods

Inheritance

↳ object

    ↳ WorkflowRuntimeGetActorsApi

Inherited Members

Equals(object)

Equals(object, object)

GetHashCode()

GetType()

MemberwiseClone()

ReferenceEquals(object, object)

ToString()

Namespace: OptimaJet.Workflow.Core.Runtime

Assembly: OptimaJet.Workflow.Core.dll

Syntax

public static class WorkflowRuntimeGetActorsApi

Methods

GetAllActorsForAllCommandTransitionsAsync(WorkflowRuntime, Guid, bool, string, CancellationToken)

Get the list of user ids which can execute any command for specified process activity (async version)

Declaration

public static Task<IEnumerable<string>> GetAllActorsForAllCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default)

Parameters

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

Returns

Type	Description
Task<IEnumerable<string>>	List of user ids

GetAllActorsForDirectCommandTransitionsAsync(WorkflowRuntime, Guid, bool, string, CancellationToken)

Get the list of user ids which can execute any command bound with direct transitions (by transition classifier) for specified process activity (async version)

Declaration

public static Task<IEnumerable<string>> GetAllActorsForDirectCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default)

Parameters

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

Returns

Type	Description
Task<IEnumerable<string>>	List of user ids

GetAllActorsForDirectAndUndefinedCommandTransitionsAsync(WorkflowRuntime, Guid, bool, string, CancellationToken)

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)

Declaration

public static Task<IEnumerable<string>> GetAllActorsForDirectAndUndefinedCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default)

Parameters

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

Returns

Type	Description
Task<IEnumerable<string>>	List of user ids

GetAllActorsForReverseCommandTransitionsAsync(WorkflowRuntime, Guid, bool, string, CancellationToken)

Get the list of user ids which can execute any command bound with reverse transitions (by transition classifier) for specified process activity (async version)

Declaration

public static Task<IEnumerable<string>> GetAllActorsForReverseCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default)

Parameters

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

Returns

Type	Description
Task<IEnumerable<string>>	List of user ids

GetAllActorsForCommandTransitionsAsync(WorkflowRuntime, Guid, List<TransitionClassifier>, bool, string, CancellationToken)

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

Declaration

public static Task<IEnumerable<string>> GetAllActorsForCommandTransitionsAsync(this WorkflowRuntime runtime, Guid processId, List<TransitionClassifier> classifiers, bool beginningWithRoot = false, string activityName = null, CancellationToken token = default)

Parameters

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

Returns

Type	Description
Task<IEnumerable<string>>	List of user ids

GetAllActorsForCommandTransitionsAsync(WorkflowRuntime, ProcessInstance, List<TransitionClassifier>, CancellationToken)

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.

Declaration

public static Task<IEnumerable<string>> GetAllActorsForCommandTransitionsAsync(this WorkflowRuntime runtime, ProcessInstance processInstance, List<TransitionClassifier> classifiers = null, CancellationToken token = default)

Parameters

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

Returns

Type	Description
Task<IEnumerable<string>>	List of user ids

GetAllActorsForCommandTransitionsAsync(WorkflowRuntime, TreeSearchFilter, List<TransitionClassifier>, CancellationToken)

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)

Declaration

public static Task<IEnumerable<string>> GetAllActorsForCommandTransitionsAsync(this WorkflowRuntime runtime, TreeSearchFilter filter, List<TransitionClassifier> classifiers = null, CancellationToken token = default)

Parameters

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

Returns

Type	Description
Task<IEnumerable<string>>	List of user ids

GetAllActorsForAllCommandTransitions(WorkflowRuntime, Guid, bool, string)

Get the list of user ids which can execute any command for specified process activity

Declaration

public static IEnumerable<string> GetAllActorsForAllCommandTransitions(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null)

Parameters

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

Returns

Type	Description
IEnumerable<string>	List of user ids

GetAllActorsForDirectCommandTransitions(WorkflowRuntime, Guid, bool, string)

Get the list of user ids which can execute any command bound with direct transitions (by transition classifier) for specified process activity

Declaration

public static IEnumerable<string> GetAllActorsForDirectCommandTransitions(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null)

Parameters

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

Returns

Type	Description
IEnumerable<string>	List of user ids

GetAllActorsForDirectAndUndefinedCommandTransitions(WorkflowRuntime, Guid, bool, string)

Get the list of user ids which can execute any command bound with direct or undefined transitions (by transition classifier) for specified process activity

Declaration

public static IEnumerable<string> GetAllActorsForDirectAndUndefinedCommandTransitions(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null)

Parameters

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

Returns

Type	Description
IEnumerable<string>	List of user ids

GetAllActorsForReverseCommandTransitions(WorkflowRuntime, Guid, bool, string)

Get the list of user ids which can execute any command bound with reverse transitions (by transition classifier) for specified process activity

Declaration

public static IEnumerable<string> GetAllActorsForReverseCommandTransitions(this WorkflowRuntime runtime, Guid processId, bool beginningWithRoot = false, string activityName = null)

Parameters

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

Returns

Type	Description
IEnumerable<string>	List of user ids

GetAllActorsForCommandTransitions(WorkflowRuntime, Guid, List<TransitionClassifier>, bool, string)

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

Declaration

public static IEnumerable<string> GetAllActorsForCommandTransitions(this WorkflowRuntime runtime, Guid processId, List<TransitionClassifier> classifiers, bool beginningWithRoot = false, string activityName = null)

Parameters

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

Returns

Type	Description
IEnumerable<string>	List of user ids

GetAllActorsForCommandTransitions(WorkflowRuntime, ProcessInstance, List<TransitionClassifier>)

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.

Declaration

public static IEnumerable<string> GetAllActorsForCommandTransitions(this WorkflowRuntime runtime, ProcessInstance processInstance, List<TransitionClassifier> classifiers = null)

Parameters

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

Returns

Type	Description
IEnumerable<string>	List of user ids

GetAllActorsForCommandTransitions(WorkflowRuntime, TreeSearchFilter, List<TransitionClassifier>)

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

Declaration

public static IEnumerable<string> GetAllActorsForCommandTransitions(this WorkflowRuntime runtime, TreeSearchFilter filter, List<TransitionClassifier> classifiers = null)

Parameters

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

Returns

Type	Description
IEnumerable<string>	List of user ids