at.srfg.miner.clientlib

Class Task

Object

at.srfg.miner.clientlib.Task

public class Task
extends Object

A MINER task is a part of the scenario specification. The task is a child element of the Scenario. The following table lists the required and optional properties of a task.

Required?	Name	Description	Quantity
yes	action	A MINER action	1..N
no	name	The name of the task	0..1
no	description	The description of the task	0..1
no	deltaStart	Start offset of the task w.r.t its parent scenario	0..1
no	duration	The duration of the task	0..1
no	keyword	The keywords of the task	0..N

Constructor Summary

Constructors

Constructor and Description
Task() Default constructor.
Task(String name) Creates a new task and set its name.

Method Summary

Methods

Modifier and Type	Method and Description
Action	addAction() Creates a new MINER action and adds it to this task.
Action	addAction(Action action) Adds a MINER action to this task.
Action	addAction(String name) Creates a new MINER action with the given name and adds it to this task.
void	addKeyword(String keyword) Adds a keyword for this task.
Action	getActionByName(String actionName) Finds an action named actionName that is part of this task.
Collection<Action>	getActions() Gets all actions that are included in this task.
Date	getCreated() Gets the date when the Task was initially created.
double	getDeltaStart() Gets the offset in [s] between the start time of the parent task and this action.
String	getDescription() Gets the description of the task.
double	getDuration() Gets the duration in [s] of the task.
int	getID() Gets the ID that identifies the task at the MINER core.
List<String>	getKeywords() Gets the keywords of this task.
Date	getModified() Gets the date when the task was last modified.
String	getName() Gets the name of the task.
void	setDeltaStart(double deltastart) Specifies that the task should start deltaStart [s] later than its parent scenario.
void	setDescription(String description) Sets the description of the task.
void	setDuration(double duration) Sets the duration of this Task in [s].
void	setName(String name) Sets the name of the task.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Task

public Task()

Default constructor.

Task

public Task(String name)

Creates a new task and set its name.

Parameters:

name - the name

Method Detail

setName

public void setName(String name)

Sets the name of the task.

Parameters:

name - the name

getName

public String getName()

Gets the name of the task.

Returns:

the name

setDescription

public void setDescription(String description)

Sets the description of the task.

Parameters:

description - the description

getDescription

public String getDescription()

Gets the description of the task.

Returns:

the description

setDeltaStart

public void setDeltaStart(double deltastart)

Specifies that the task should start deltaStart [s] later than its parent scenario. If this method is not used (or if deltaStart==0) the parent scenario and this task start at the same time.

Parameters:

deltastart - the offset in seconds

getDeltaStart

public double getDeltaStart()

Gets the offset in [s] between the start time of the parent task and this action.

Returns:

the offset in seconds

setDuration

public void setDuration(double duration)

Sets the duration of this Task in [s]. If no duration is set (or if duration==0) then the Task runs as long as its parent Scenario.

Parameters:

duration - the duration in seconds

getDuration

public double getDuration()

Gets the duration in [s] of the task.

Returns:

the duration in seconds

addKeyword

public void addKeyword(String keyword)

Adds a keyword for this task.

Parameters:

keyword - the keyword

getKeywords

public List<String> getKeywords()

Gets the keywords of this task.

Returns:

a list of keywords

addAction

public Action addAction()

Creates a new MINER action and adds it to this task.

Returns:

the newly created action.

addAction

public Action addAction(String name)

Creates a new MINER action with the given name and adds it to this task.

Parameters:

name - the name of the action

Returns:

the newly created action

addAction

public Action addAction(Action action)

Adds a MINER action to this task.

Parameters:

action - the MINER action

Returns:

the input parameter action

getCreated

public Date getCreated()

Gets the date when the Task was initially created.

Returns:

the date

getModified

public Date getModified()

Gets the date when the task was last modified.

Returns:

the date

getID

public int getID()

Gets the ID that identifies the task at the MINER core.

Returns:

the identifier

getActions

public Collection<Action> getActions()

Gets all actions that are included in this task.

Returns:

a collection of Actions

getActionByName

public Action getActionByName(String actionName)

Finds an action named actionName that is part of this task.

Parameters:

actionName - the name of action to search for

Returns:

the first action found or null if none is found.