vgrid.task
Class AbstractTask

java.lang.Object
  vgrid.task.AbstractTask

All Implemented Interfaces:

java.io.Serializable, Task

public abstract class AbstractTask
extends java.lang.Object
implements Task

An abstract task that does nothing but holding the fields needed by the framework. You may derive your tasks from that class or implement the task interface.

See Also:

Serialized Form

Field Summary

protected java.lang.String	executionHistory
protected java.lang.String	id

Constructor Summary

AbstractTask()

AbstractTask(java.lang.String id)

Method Summary

java.lang.String	getExecutionHistory() The execution history field must exist.
java.lang.String	getId() Gets the tasks unique id.
protected void	pause(int ms)
void	setExecutionHistory(java.lang.String executionHistory) Sets the tasks execution history.
void	setId(java.lang.String id) The id field must exist.

Methods inherited from class java.lang.Object

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

Methods inherited from interface vgrid.task.Task

isFinished, takeOneStep, toStateString

Field Detail

id

protected java.lang.String id

executionHistory

protected java.lang.String executionHistory

Constructor Detail

AbstractTask

public AbstractTask()

AbstractTask

public AbstractTask(java.lang.String id)

Method Detail

setId

public void setId(java.lang.String id)

The id field must exist. Otherwise the server cannot store your task. There is no need to (de)serialize this field as it is done by the client.

Specified by:

setId in interface Task

Parameters:

id - Unique id.

getId

public java.lang.String getId()

Description copied from interface: Task

Gets the tasks unique id.

Specified by:

getId in interface Task

Returns:

The id.

getExecutionHistory

public java.lang.String getExecutionHistory()

The execution history field must exist. Otherwise the client cannot write history entries. There is no need to (de)serialize this field as it is done by the client.

Specified by:

getExecutionHistory in interface Task

Returns:

The execution history.

setExecutionHistory

public void setExecutionHistory(java.lang.String executionHistory)

Description copied from interface: Task

Sets the tasks execution history. Typically this method is used by the client to inform the vendor what happend during execution. If an exception occures dureing execution the vendor finds the execution stack here.

Specified by:

setExecutionHistory in interface Task

Parameters:

executionHistory - The message to be reported.

pause

protected void pause(int ms)