org.gcube.vremanagement.executor.state

Class TaskRuntime

java.lang.Object

org.gcube.vremanagement.executor.state.TaskRuntime

public class TaskRuntime
extends Object

The runtime environment of the task.

Author:

Fabio Simeoni (University of Strathclyde)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TaskRuntime.Entry A wrapper for named output to be used for bulk addition.

Constructor Summary

Constructors

Constructor and Description
TaskRuntime() Creates an instance.
TaskRuntime(TaskResource resource) Creates an instance with an associated TaskResource

Method Summary

Methods

Modifier and Type	Method and Description
Object	addOutput(String name, Object value) Adds an output.
void	addOutput(TaskRuntime.Entry... entries) Adds one or more outputs.
ExecutorPluginContext	getContext() Returns the context of the plugin's task.
Object	getInput(String name) Returns an input given its name.
Map<String,Object>	getInputs() Returns the task inputs.
Calendar	getStartTime() Returns the start time of the task.
void	removeOutput(String... names) Removes one or more outputs.
void	throwException(Exception e) Throws an exception shows as the value of the error RP.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskRuntime

public TaskRuntime()

Creates an instance.

TaskRuntime

public TaskRuntime(TaskResource resource)

Creates an instance with an associated TaskResource

Parameters:

resource -

Method Detail

getContext

public ExecutorPluginContext getContext()

Returns the context of the plugin's task.

Returns:

the context.

getStartTime

public Calendar getStartTime()

Returns the start time of the task.

Returns:

the start time.

getInputs

public Map<String,Object> getInputs()

Returns the task inputs.

Returns:

the inputs.

getInput

public Object getInput(String name)

Returns an input given its name.

Returns:

the input.

addOutput

public Object addOutput(String name,
               Object value)

Adds an output.

Parameters:

name - the name of the output.

value - the output.

Returns:

any output previously stored with the same name.

addOutput

public void addOutput(TaskRuntime.Entry... entries)

Adds one or more outputs.

Parameters:

entries - the outputs.

removeOutput

public void removeOutput(String... names)

Removes one or more outputs.

Parameters:

names - the name of the outputs

throwException

public void throwException(Exception e)

Throws an exception shows as the value of the error RP.

Parameters:

e - the exception.