org.ow2.proactive.scheduler.task

Class ClientTaskState

java.lang.Object

org.ow2.proactive.scheduler.common.task.CommonAttribute

org.ow2.proactive.scheduler.common.task.Task

org.ow2.proactive.scheduler.common.task.TaskState

org.ow2.proactive.scheduler.task.ClientTaskState

All Implemented Interfaces:

Serializable, Comparable<TaskState>

public final class ClientTaskState
extends TaskState

This class is a client view of a TaskState. A client may access instances of this class when connecting to the scheduler front-end and ask for a JobState (for instance by using Scheduler.getJobState(String)). The value of some attributes will not be available in this view of the TaskState. Therefore, calling the respective getters will throw a RuntimeException. See the public method's javadoc for more details.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.ow2.proactive.scheduler.common.task.TaskState

ASC_ORDER, COMPARE_BY_FINISHED_TIME_ASC, currentOrder, currentSort, DESC_ORDER, SORT_BY_DESCRIPTION, SORT_BY_EXEC_DURATION, SORT_BY_EXECUTIONLEFT, SORT_BY_EXECUTIONONFAILURELEFT, SORT_BY_FINISHED_TIME, SORT_BY_HOST_NAME, SORT_BY_ID, SORT_BY_NAME, SORT_BY_STARTED_TIME, SORT_BY_STATUS

Fields inherited from class org.ow2.proactive.scheduler.common.task.Task

cScript, description, flowBlock, flowScript, forkEnvironment, inputFiles, name, outputFiles, parallelEnvironment, postScript, preciousLogs, preciousResult, preScript, runAsMe, sScripts, tag, variables, wallTime

Fields inherited from class org.ow2.proactive.scheduler.common.task.CommonAttribute

GENERIC_INFO_START_AT_KEY, genericInformation, onTaskError, restartTaskOnError, unresolvedGenericInformation

Constructor Summary

Constructors

Constructor and Description
ClientTaskState(TaskState taskState)

Method Summary

Modifier and Type	Method and Description
List<TaskState>	getDependences() To get the dependences of this task.
FlowScript	getFlowScript() This property is not available for this implementation.
List<InputSelector>	getInputFilesList() This property is not available for this implementation.
int	getIterationIndex() When Control Flow actions are performed (see Task.getFlowScript()), some tasks are replicated.
int	getMaxNumberOfExecution() Get the number of execution allowed for this task.
int	getMaxNumberOfExecutionOnFailure() Get the number of execution on failure allowed by the task.
List<OutputSelector>	getOutputFilesList() This property is not available for this implementation.
Script<?>	getPostScript() This property is not available for this implementation.
Script<?>	getPreScript() This property is not available for this implementation.
int	getReplicationIndex() When Control Flow actions are performed (see Task.getFlowScript()), some tasks are replicated.
RestartMode	getRestartTaskOnError() This property is not available for this implementation.
List<SelectionScript>	getSelectionScripts() This property is not available for this implementation.
TaskInfo	getTaskInfo() To get the taskInfo
TaskState	replicate() Replicates a task
void	restoreDependences(Map<TaskId,TaskState> tasksMap)
void	update(TaskInfo taskInfo) To update this taskState using a taskInfo

Methods inherited from class org.ow2.proactive.scheduler.common.task.TaskState

addDependence, addDependences, compareTo, equals, getDependencesList, getExecutionDuration, getExecutionHostName, getExecutionHostNameList, getFinishedTime, getId, getJobId, getName, getNumberOfExecutionLeft, getNumberOfExecutionOnFailureLeft, getProgress, getRuntimeGenericInformation, getRuntimeVariables, getScheduledTime, getScopeVariables, getStartTime, getStatus, getSystemVariables, hashCode, isTaskAlive, setSortingBy, setSortingOrder, toString

Methods inherited from class org.ow2.proactive.scheduler.common.task.Task

addInputFiles, addInputFiles, addOutputFiles, addOutputFiles, addSelectionScript, display, getCleaningScript, getDescription, getFlowBlock, getForkEnvironment, getNumberOfNodesNeeded, getParallelEnvironment, getTag, getVariables, getVariablesOverriden, getWallTime, getWorkingDir, isParallel, isPreciousLogs, isPreciousResult, isRunAsMe, isWallTimeSet, setCleaningScript, setDescription, setFlowBlock, setFlowScript, setForkEnvironment, setName, setNumberOfNeededNodes, setParallelEnvironment, setPostScript, setPreciousLogs, setPreciousResult, setPreScript, setRunAsMe, setSelectionScript, setSelectionScripts, setTag, setVariables, setWallTime

Methods inherited from class org.ow2.proactive.scheduler.common.task.CommonAttribute

addGenericInformation, addGenericInformations, applyReplacementsOnGenericInformation, getGenericInformation, getMaxNumberOfExecutionProperty, getOnTaskErrorProperty, getRestartTaskOnErrorProperty, getUnresolvedGenericInformation, setGenericInformation, setMaxNumberOfExecution, setOnTaskError, setRestartTaskOnError, setUnresolvedGenericInformation

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClientTaskState

public ClientTaskState(TaskState taskState)

Method Detail

update

public void update(TaskInfo taskInfo)

Description copied from class: TaskState

To update this taskState using a taskInfo

Specified by:

update in class TaskState

Parameters:

taskInfo - the taskInfo to set

getDependences

public List<TaskState> getDependences()

Description copied from class: TaskState

To get the dependences of this task. Return null if this task has no dependence.

Specified by:

getDependences in class TaskState

Returns:

the dependences of this task

getTaskInfo

public TaskInfo getTaskInfo()

Description copied from class: TaskState

To get the taskInfo

Specified by:

getTaskInfo in class TaskState

Returns:

the taskInfo

getMaxNumberOfExecutionOnFailure

public int getMaxNumberOfExecutionOnFailure()

Description copied from class: TaskState

Get the number of execution on failure allowed by the task.

Specified by:

getMaxNumberOfExecutionOnFailure in class TaskState

Returns:

the number of execution on failure allowed by the task

replicate

public TaskState replicate()
                    throws Exception

Description copied from class: TaskState

Replicates a task

Deep copies all fields, does not share any reference

Specified by:

replicate in class TaskState

Returns:

the newly created task, cast as a TaskState

Throws:

Exception

getIterationIndex

public int getIterationIndex()

Description copied from class: TaskState

When Control Flow actions are performed (see Task.getFlowScript()), some tasks are replicated. A task replicated by a FlowActionType.LOOP action is differentiated from the original by an incremented Iteration Index.

Specified by:

getIterationIndex in class TaskState

Returns:

the iteration number of this task if it was replicated by a LOOP flow operation (>= 0)

getReplicationIndex

public int getReplicationIndex()

Description copied from class: TaskState

When Control Flow actions are performed (see Task.getFlowScript()), some tasks are replicated. A task replicated by a FlowActionType.REPLICATE action is differentiated from the original by an incremented Replication Index.

Specified by:

getReplicationIndex in class TaskState

Returns:

the replication number of this task if it was replicated by a REPLICATE flow operations (>= 0)

restoreDependences

public void restoreDependences(Map<TaskId,TaskState> tasksMap)

getMaxNumberOfExecution

public int getMaxNumberOfExecution()

Description copied from class: CommonAttribute

Get the number of execution allowed for this task.

Overrides:

getMaxNumberOfExecution in class CommonAttribute

Returns:

the number of execution allowed for this task

getInputFilesList

public List<InputSelector> getInputFilesList()

This property is not available for this implementation. Calling this method will throw a RuntimeException

Overrides:

getInputFilesList in class Task

Returns:

the input file selectors list

getOutputFilesList

public List<OutputSelector> getOutputFilesList()

This property is not available for this implementation. Calling this method will throw a RuntimeException

Overrides:

getOutputFilesList in class Task

Returns:

the output file selectors list

getPreScript

public Script<?> getPreScript()

This property is not available for this implementation. Calling this method will throw a RuntimeException

Overrides:

getPreScript in class Task

Returns:

the preScript of this task.

getPostScript

public Script<?> getPostScript()

This property is not available for this implementation. Calling this method will throw a RuntimeException

Overrides:

getPostScript in class Task

Returns:

the postScript of this task.

getSelectionScripts

public List<SelectionScript> getSelectionScripts()

This property is not available for this implementation. Calling this method will throw a RuntimeException

Overrides:

getSelectionScripts in class Task

Returns:

the selection Script.

getFlowScript

public FlowScript getFlowScript()

This property is not available for this implementation. Calling this method will throw a RuntimeException

Overrides:

getFlowScript in class Task

Returns:

the Control Flow Script used for workflow actions

getRestartTaskOnError

public RestartMode getRestartTaskOnError()

This property is not available for this implementation. Calling this method will throw a RuntimeException

Overrides:

getRestartTaskOnError in class CommonAttribute

Returns:

the restartTaskOnError state.