Package de.espirit.firstspirit.workflow

Interface WorkflowAgent

public interface WorkflowAgent

Agent providing means to start new workflows or process steps in existing ones.
This agent is related to the project specified by the surrounding context.

Example:
SpecialistsBroker.requireSpecialist(WorkflowAgent.TYPE)

Since:

5.0.207

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WorkflowAgent.TimeoutException	Exception thrown if a timeout occurred.
static interface	WorkflowAgent.WorkflowProcessContext	Context representing a manual activity in the corresponding workflow process.

Field Summary

Fields

Modifier and Type	Field	Description
static final SpecialistType<WorkflowAgent>	TYPE	The agent's technical type to be used to request the agent from a SpecialistsBroker.

Method Summary

Modifier and Type	Method	Description
boolean	isTransitionAllowed(@NotNull Task task, @NotNull StoreElement element, @NotNull Transition transition, @NotNull User user)	Returns whether or not a Transition is allowed for a given Task performed by a User on a StoreElement
WorkflowAgent.WorkflowProcessContext	process(@NotNull Task task, @NotNull Transition transition)	Processes the next activity of the given task specified by given transition, wherefore given transition must be one of the outgoing transitions of the current task state (task.getTaskState().getModelState().getTargetTransitions()). The returned context represents the next activity of the belonging workflow model providing means to process the next transition. If the next activity has a script, the activity will be processed automatically and the returned context provides only access to the task which is already in the next state.
@NotNull WorkflowAgent.WorkflowProcessContext	startWorkflow(@NotNull Workflow workflow)	Starts a new workflow process without context.
@NotNull WorkflowAgent.WorkflowProcessContext	startWorkflow(@NotNull Workflow workflow, @Nullable IDProvider element)	Starts a new workflow process which context is based on the given element (mode is Task.Mode.ENTITY, if given element is a Dataset, otherwise Task.Mode.STORE_ELEMENT).

Field Details

TYPE

static final SpecialistType<WorkflowAgent> TYPE

The agent's technical type to be used to request the agent from a SpecialistsBroker.

Since:

5.0.207

Method Details

startWorkflow

@NotNull
@NotNull WorkflowAgent.WorkflowProcessContext startWorkflow(@NotNull
 @NotNull Workflow workflow)

Starts a new workflow process without context. This method will create a new task which will be reachable via the returned context.

The returned context represents the first manual activity of the corresponding workflow model, providing means to process the next transition.
If the first activity is denoted as automatic, the activity will be processed automatically and the returned context just provides access to the task which is already in the next state.

Throws:

IllegalArgumentException - if provided workflow and provided element do not belong to the same project.

Since:

5.0.207

startWorkflow

@NotNull
@NotNull WorkflowAgent.WorkflowProcessContext startWorkflow(@NotNull
 @NotNull Workflow workflow,
 @Nullable
 @Nullable IDProvider element)
                                                     throws LockException,
ElementDeletedException

Starts a new workflow process which context is based on the given element (mode is Task.Mode.ENTITY, if given element is a Dataset, otherwise Task.Mode.STORE_ELEMENT). This method will create a new task which is reachable through getTask() of the returned context instance.

The returned context represents the first manual activity of the corresponding workflow model providing means to process the next transition.
If the first activity is denoted as automatic, the activity will be processed automatically and the returned context just provides access to the task which is already in the next state.

Throws:

IllegalArgumentException - if provided workflow and provided element do not belong to the same project.

LockException

ElementDeletedException

Since:

5.0.207

process

WorkflowAgent.WorkflowProcessContext process(@NotNull
 @NotNull Task task,
 @NotNull
 @NotNull Transition transition)
                                      throws LockException

Processes the next activity of the given task specified by given transition, wherefore given transition must be one of the outgoing transitions of the current task state (task.getTaskState().getModelState().getTargetTransitions()).
The returned context represents the next activity of the belonging workflow model providing means to process the next transition.
If the next activity has a script, the activity will be processed automatically and the returned context provides only access to the task which is already in the next state.

Throws:

IllegalArgumentException - if given task or transition are not part of the corresponding workflow model.

LockException - during lock problems with elements related to context based tasks

Since:

5.0.207

isTransitionAllowed

boolean isTransitionAllowed(@NotNull
 @NotNull Task task,
 @NotNull
 @NotNull StoreElement element,
 @NotNull
 @NotNull Transition transition,
 @NotNull
 @NotNull User user)

Returns whether or not a Transition is allowed for a given Task performed by a User on a StoreElement

Parameters:

task - The Task to test

element - The StoreElement to test

transition - The Transition to test

user - The User to test

Since:

5.2.211004

See Also:

• StoreElement.isWorkflowAllowed(Workflow, User)