de.aristaflow.adept2.model.execution

Interface ExecutionContext

All Superinterfaces:

PluginDataContainer, java.io.Serializable, UserAttributeContainer

public interface ExecutionContext
extends java.io.Serializable, UserAttributeContainer, PluginDataContainer

This interface provides methods to get all the information necessary for the execution of an activity by the runtime client. In detail these are the information about

• the user who requested the execution of the activity
• the position in the organisation he had occupied when he requested the execution
• the activity that should be executed with all the necessary execution properties
• the valid data context for that activity.

Author:

Markus Lauer

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID Generated ID for serialisation.

Method Summary

Modifier and Type	Method and Description
QualifiedAgent	getAgent() Returns the user that requested the execution of the activity.
Enquiry	getCurrentEnquiry() Gets the current enquiry in case the activity is executed as enquiry.
DataContainer	getDataContainer() Returns the data context valid for the requested activity.
ExecutableBusinessProcessInstance	getEBPInstance() Returns an object that keeps all the information about the EBP to be executed.
ProcessConstants.ExecutionMode	getExecutionMode() Informs the runtime manager about the execution mode.
Enquiry	getRepliedEnquiry() Gets the replied enquiry in case the activity has been made an enquiry for (by the current user) and this has been replied now.
boolean	resume() Gets whether the execution of the activity is resumed.

Methods inherited from interface de.aristaflow.adept2.model.common.UserAttributeContainer

getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValue

Methods inherited from interface de.aristaflow.adept2.model.common.PluginDataContainer

getPluginData, getPluginDatas, getSupportedPlugins

Field Detail

serialVersionUID

static final long serialVersionUID

Generated ID for serialisation.

See Also:

Constant Field Values

Method Detail

getAgent

QualifiedAgent getAgent()

Returns the user that requested the execution of the activity.

Returns:

the user

getEBPInstance

ExecutableBusinessProcessInstance getEBPInstance()

Returns an object that keeps all the information about the EBP to be executed. The EBP might either be an ActivityInstance or a LightWeightProcessInstance.
This may be null in execution contexts for starting top-level instances.

Returns:

the object keeping all the information

getDataContainer

DataContainer getDataContainer()

Returns the data context valid for the requested activity.

Returns:

the data container

getExecutionMode

ProcessConstants.ExecutionMode getExecutionMode()

Informs the runtime manager about the execution mode.

Returns:

the execution mode

See Also:

for more information

resume

boolean resume()

Gets whether the execution of the activity is resumed. The corresponding savepoint is last savepoint as provided by the data container in the execution context.

Returns:

Whether the execution of the activity is resumed or started normally.

getCurrentEnquiry

Enquiry getCurrentEnquiry()

Gets the current enquiry in case the activity is executed as enquiry. An enquiry allows an agent to request further information or even assistance from another agent. Since enquiries can be nested, there may be two different enquiries for an activity: the current activity which is the question to answer for the current user and a replied enquiry which answers the question the current user has made an enquiry for (if so).

If the activity is not executed as enquiry, the returned Enquiry will be null. The reply will obviously always be null.

Returns:

The enquiry set for assistance by the current agent.

getRepliedEnquiry

Enquiry getRepliedEnquiry()

Gets the replied enquiry in case the activity has been made an enquiry for (by the current user) and this has been replied now. The reply of the enquiry recipient is contained in the returned enquiry.

If the activity has not been made an enquiry for, the returned Enquiry will be null.

Returns:

The enquiry set by the current agent needing assistance.