ch.tatool.exec

Interface ExecutionContext

All Superinterfaces:

PropertyHolder

All Known Implementing Classes:

ExecutionContextImpl

public interface ExecutionContext
extends PropertyHolder

Execution context This is a one stop shop for elements during execution. Everything they possibly need during execution is contained in this object. Please note that the context can change from one to the next execution, therefore do not cache the object inside the elements.

Author:

Michael Ruflin

Method Summary

Methods

Modifier and Type	Method and Description
Element	getActiveElement() Get the active Element.
Executable	getActiveExecutable() Get the currently scheduled or executed ExecutableElement.
DataService	getDataService() Get the data service that allows access to the data layer of Tatool.
List<Element>	getElementStack() Get the element stack, the stack of elements being executed.
ExecutionData	getExecutionData() Get access to the execution data.
ExecutionDisplay	getExecutionDisplay() Get the display object that allows the elements to interact with the display.
Executor	getExecutor() Get the executor of this module.
ExecutionPhase	getPhase() Get the current phase of the execution.

Methods inherited from interface ch.tatool.data.PropertyHolder

clearProperties, getId, getKeys, getProperty, removeProperty, setProperty

Method Detail

getPhase

ExecutionPhase getPhase()

Get the current phase of the execution.

Returns:

the current phase

getExecutor

Executor getExecutor()

Get the executor of this module. Provides access to execution specific functionality.

Returns:

the Executor object

getDataService

DataService getDataService()

Get the data service that allows access to the data layer of Tatool.

Returns:

the DataService object

getExecutionDisplay

ExecutionDisplay getExecutionDisplay()

Get the display object that allows the elements to interact with the display.

Returns:

the ExecutionDisplay object

getExecutionData

ExecutionData getExecutionData()

Get access to the execution data.

getActiveExecutable

Executable getActiveExecutable()

Get the currently scheduled or executed ExecutableElement. This object is available between PRE_PROCESS and POST_PROCESS.

Returns:

the ExecutableElement object or null

getActiveElement

Element getActiveElement()

Get the active Element.

getElementStack

List<Element> getElementStack()

Get the element stack, the stack of elements being executed. This object is always available, but empty before and including SESSION_START and after and including SESSION_END

Returns:

the list of elements, beginning with the root element, containing the executable element as last element