ch.tatool.exec

Interface ExecutionData

public interface ExecutionData

The Execution Data object gives you access to the core data objects of Tatool, including the module, the session and trials.

Author:

Michael Ruflin

Method Summary

Methods

Modifier and Type	Method and Description
Trial	addTrial() Add a new trial to the list of trials for the current execution.
Trial	getCreateFirstTrial() Get the first trial in the list, create a trial if none exist.
Trial	getCreateLastTrial() Get the last trial in the list, create a trial if none exist.
Module	getModule() Get the module object.
ModuleSession	getModuleSession() Get the module session object.
int	getSessionCompleted() Gets the session completed flag which helps identifying whether the session was cancelled or completed
List<Trial>	getTrials() Get the trial objects for the actual execution.
void	markSessionEnd() Request the current session to be closed after the execution of the current element.
void	setSessionCompleted(int completed) Sets the completed flag for a session which allows to identify cancelled sessions later on

Method Detail

getModule

Module getModule()

Get the module object. The module object is always available.

Returns:

the module object

getModuleSession

ModuleSession getModuleSession()

Get the module session object. The session object is available between SESSION_START and SESSION_FINISH.

Returns:

the session object

getTrials

List<Trial> getTrials()

Get the trial objects for the actual execution. This object is only available during element execution (PRE_PROCESS - POST_PROCESS)

Returns:

the trial object

getCreateFirstTrial

Trial getCreateFirstTrial()

Get the first trial in the list, create a trial if none exist.

getCreateLastTrial

Trial getCreateLastTrial()

Get the last trial in the list, create a trial if none exist.

addTrial

Trial addTrial()

Add a new trial to the list of trials for the current execution. The trial will be stored with the same index as the first trial provided by the system. All trials are stored at once at the end of each element execution.

markSessionEnd

void markSessionEnd()

Request the current session to be closed after the execution of the current element. If further elements are executed during the current run, a new session will be created.

setSessionCompleted

void setSessionCompleted(int completed)

Sets the completed flag for a session which allows to identify cancelled sessions later on

getSessionCompleted

int getSessionCompleted()

Gets the session completed flag which helps identifying whether the session was cancelled or completed