Package de.espirit.firstspirit.access

Interface WorkflowContext

public interface WorkflowContext

Context object for performing a task state change. $Date$

Since:

4.0.120

Version:

$Revision$

Method Summary

Modifier and Type	Method	Description
@NotNull WorkflowScriptContext	createWorkflowScriptContext(Script script, Transition transition, Activity activity, TaskState.Mode callMode, @Nullable Data data)	Deprecated, for removal: This API element is subject to removal in a future version. since 5.2.21 - use createWorkflowScriptContext(Script, Transition, Activity, TaskState.Mode, FormData)
WorkflowScriptContext	createWorkflowScriptContext(Script script, Transition transition, Activity activity, TaskState.Mode callMode, @Nullable FormData data)	Create script context for executing a script.
@Nullable IDProvider	getElement()	Returns the element or null for tasks with no context element.
@Nullable StoreElement	getStoreElement()	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0.207 use getElement() instead
@Nullable TransitionParameters	getTargetTransition()	Returns workflow transition parameters, if already set.
@NotNull Task	getTask()	Get the task.
User	getUser()	Get the owner User of this WorkflowContext
@Nullable Workflowable	getWorkflowable()	Get StoreElement.
@Nullable TransitionParameters	selectManualTransition(Transition transition)	Select manual workflow transition parameters (show dialog).
void	sendEMail(Activity activity, State state)	Called to send a email if a new task state is reached.
void	sendEMail(Transition transition)	Called to send a email on transition activation.

Method Details

getTask

@NotNull
@NotNull Task getTask()

Get the task.

Since:

4.0.120

getStoreElement

@Nullable
@Deprecated(forRemoval=true)
@Nullable StoreElement getStoreElement()

Deprecated, for removal: This API element is subject to removal in a future version.

since 5.0.207 use getElement() instead

Get StoreElement. May be null for tasks with no context and my be the same as the Workflowable.

Since:

4.0.120

getElement

@Nullable
@Nullable IDProvider getElement()

Returns the element or null for tasks with no context element. The given element may be the same as getWorkflowable()

Since:

5.0.207

getWorkflowable

@Nullable
@Nullable Workflowable getWorkflowable()

Get StoreElement. May be null for tasks with no context and my be the same as the StoreElement.

Since:

4.0.120

getUser

User getUser()

Get the owner User of this WorkflowContext

Since:

4.0.120

createWorkflowScriptContext

@NotNull
@Deprecated(forRemoval=true)
@NotNull WorkflowScriptContext createWorkflowScriptContext(Script script,
 Transition transition,
 Activity activity,
 TaskState.Mode callMode,
 @Nullable
 @Nullable Data data)

Deprecated, for removal: This API element is subject to removal in a future version.

since 5.2.21 - use createWorkflowScriptContext(Script, Transition, Activity, TaskState.Mode, FormData)

Create script context for executing a script.

Since:

4.0.120

createWorkflowScriptContext

WorkflowScriptContext createWorkflowScriptContext(Script script,
 Transition transition,
 Activity activity,
 TaskState.Mode callMode,
 @Nullable
 @Nullable FormData data)

Create script context for executing a script.

Since:

5.2.21

selectManualTransition

@Nullable
@Nullable TransitionParameters selectManualTransition(Transition transition)

Select manual workflow transition parameters (show dialog). Return null if transition was canceled.

Since:

4.0.120

sendEMail

void sendEMail(Transition transition)

Called to send a email on transition activation.

Since:

4.0.120

sendEMail

void sendEMail(Activity activity,
 State state)

Called to send a email if a new task state is reached.

Since:

4.0.120

getTargetTransition

@Nullable
@Nullable TransitionParameters getTargetTransition()

Returns workflow transition parameters, if already set.

Returns:

the selected transition parameters or null

Since:

4.2.451