Package de.espirit.firstspirit.workflow

Interface WorkflowAgent.WorkflowProcessContext

All Superinterfaces:

BaseContext, SpecialistsBroker

Enclosing interface:

WorkflowAgent

public static interface WorkflowAgent.WorkflowProcessContext
extends BaseContext

Context representing a manual activity in the corresponding workflow process. Provides means to process the next workflow step.
The possible outgoing transitions of this activity targeting the next state are provided via getTransitions(). The user of this context has to decide which transition should be processed by calling doTransition(Transition). All data modifying methods like getFormData(), getTransitionParameters() must be called before calling doTransition(Transition) which completes the activity.
Attention:
Some methods will throw an UnsupportedOperationException if after doTransition(Transition) has been called or the activity has been processed automatically. In both cases isActivityProcessed() returns true.
The internal workflow implementation waits until doTransition(Transition) or gotoErrorState(String, Throwable) has been called. This can cause a timeout if the answer last too long.

Since:

5.0.207

Nested Class Summary

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.BaseContext

BaseContext.Env

Method Summary

Modifier and Type	Method	Description
void	doTransition(@Nullable Transition transition)	Process the next transition (one of getTransitions() and completes this workflow process activity.
@Nullable IDProvider	getElement()	Returns the element this workflow process is related to or null if this is a workflow without context.
TaskErrorInfo	getErrorInfo()	Returns the error info which has been set in gotoErrorState(String, Throwable), or null if not in error state.
FormData	getFormData()	Returns the custom form data object
Task	getTask()	Returns the task this workflow process belongs to.
TransitionParameters	getTransitionParameters()	Delivers the transition parameters object to be filled before calling doTransition(de.espirit.firstspirit.workflow.model.Transition).
List<Transition>	getTransitions()	Return the next possible transitions of the activity this context belongs to.
void	gotoErrorState(@Nullable String comment, @Nullable Throwable throwable)	Switch this task to the error state if it is defined.
boolean	isActivityProcessed()	Indicates whether the activity this context belongs to has been processed yet or not.
@Nullable Transition	showActionDialog()	Shows an action gui dialog and returns the transition selected by the user.

Methods inherited from interface de.espirit.firstspirit.access.BaseContext

is, logDebug, logError, logError, logInfo, logWarning

Methods inherited from interface de.espirit.firstspirit.agency.SpecialistsBroker

requestSpecialist, requireSpecialist

Method Details

isActivityProcessed

boolean isActivityProcessed()

Indicates whether the activity this context belongs to has been processed yet or not. After calling doTransition(Transition) this method will deliver true. If this context is provided after an activity with a script which has been processed automatically, this method will always deliver true.

Since:

5.0.207

See Also:

• doTransition(Transition)

getElement

@Nullable
@Nullable IDProvider getElement()

Returns the element this workflow process is related to or null if this is a workflow without context.

Since:

5.0.207

doTransition

void doTransition(@Nullable
 @Nullable Transition transition)
           throws WorkflowAgent.TimeoutException

Process the next transition (one of getTransitions() and completes this workflow process activity. Use null to cancel the current activity process. This method can only be called once.

Throws:

UnsupportedOperationException - if this context is provided after an automatic activity or the activity has already been processed

WorkflowAgent.TimeoutException - if this context timed out (see server property 'workflow.api.timeout')

Since:

5.0.207

See Also:

• getTransitions()

getTransitions

List<Transition> getTransitions()

Return the next possible transitions of the activity this context belongs to.

Since:

5.0.207

See Also:

• doTransition(Transition)

getTransitionParameters

TransitionParameters getTransitionParameters()

Delivers the transition parameters object to be filled before calling doTransition(de.espirit.firstspirit.workflow.model.Transition). Calling doTransition(Transition) will set the transition in this parameters.

Throws:

UnsupportedOperationException - if this context is provided after an automatic activity or the activity has already been processed

Since:

5.0.207

getFormData

FormData getFormData()

Returns the custom form data object

Throws:

UnsupportedOperationException - if this context is provided after an automatic activity or the activity has already been processed

Since:

5.0.207

showActionDialog

@Nullable
@Nullable Transition showActionDialog()

Shows an action gui dialog and returns the transition selected by the user. All input the user made will be persisted in the belonging transition parameters.

Throws:

UnsupportedOperationException - if this context is provided in headless mode or after an automatic activity or this process has already been processed (doTransition(Transition), gotoErrorState(String, Throwable) already called)

Since:

5.0.207

gotoErrorState

void gotoErrorState(@Nullable
 @Nullable String comment,
 @Nullable
 @Nullable Throwable throwable)
             throws IllegalStateException

Switch this task to the error state if it is defined.

Throws:

IllegalStateException - if the belonging workflow model has no error state

Since:

5.0.207

getErrorInfo

TaskErrorInfo getErrorInfo()

Returns the error info which has been set in gotoErrorState(String, Throwable), or null if not in error state.

Since:

5.0.207

getTask

Task getTask()

Returns the task this workflow process belongs to.

Since:

5.0.207