TaskState (scheduling 14.1.0-SNAPSHOT API)

java.lang.Object
- org.ow2.proactive.scheduler.common.task.CommonAttribute
- - org.ow2.proactive.scheduler.common.task.Task
  - - org.ow2.proactive.scheduler.common.task.TaskState

All Implemented Interfaces:

Serializable, Comparable<TaskState>

Direct Known Subclasses:

ClientTaskState, TaskStateImpl, TaskStateImpl
```
@PublicAPI
public abstract class TaskState
extends Task
implements Comparable<TaskState>
```
This class contains all informations about the state of the task. It also provides methods and static fields to order the tasks if you hold them in a list.

Since:

ProActive Scheduling 0.9

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ASC_ORDER`
`static Comparator<TaskState>`	`COMPARE_BY_FINISHED_TIME_ASC`
`protected static int`	`currentOrder`
`protected static int`	`currentSort`
`static int`	`DESC_ORDER`
`static int`	`SORT_BY_DESCRIPTION`
`static int`	`SORT_BY_EXEC_DURATION`
`static int`	`SORT_BY_EXECUTIONLEFT`
`static int`	`SORT_BY_EXECUTIONONFAILURELEFT`
`static int`	`SORT_BY_FINISHED_TIME`
`static int`	`SORT_BY_HOST_NAME`
`static int`	`SORT_BY_ID` Sorting constant, this will allow the user to sort the descriptor.
`static int`	`SORT_BY_NAME`
`static int`	`SORT_BY_STARTED_TIME`
`static int`	`SORT_BY_STATUS`

Fields inherited from class org.ow2.proactive.scheduler.common.task.Task
cScript, description, flowBlock, flowScript, fork, 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
DEFAULT_TASK_RETRY_DELAY, GENERIC_INFO_START_AT_KEY, genericInformation, maxNumberOfExecution, onTaskError, restartTaskOnError, taskRetryDelay, unresolvedGenericInformation

Constructor Summary

Constructors
Constructor and Description

TaskState()
ProActive default constructor

Constructors
Constructor and Description
`TaskState()` ProActive default constructor

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDependence(Task task)` If the Task was submitted, a call to this method will throw a RuntimeException.
`void`	`addDependences(List<Task> tasks)` If the Task was submitted, a call to this method will throw a RuntimeException.
`int`	`compareTo(TaskState task)`
`boolean`	`equals(Object obj)`
`abstract List<TaskState>`	`getDependences()` To get the dependences of this task.
`List<Task>`	`getDependencesList()` If the Task was submitted, a call to this method will throw a RuntimeException.
`long`	`getExecutionDuration()` Get the real task duration in millis.
`String`	`getExecutionHostName()` Get the last execution HostName of the task.
`String[]`	`getExecutionHostNameList()` To get the list of execution hosts name.
`long`	`getFinishedTime()` To get the finishedTime
`TaskId`	`getId()` To get the taskId
`abstract int`	`getIterationIndex()` When Control Flow actions are performed (see `Task.getFlowScript()`), some tasks are replicated.
`JobId`	`getJobId()` To get the jobID
`abstract int`	`getMaxNumberOfExecutionOnFailure()` Get the number of execution on failure allowed by the task.
`String`	`getName()` To get the name of this task.
`int`	`getNumberOfExecutionLeft()` Get the number of execution left.
`int`	`getNumberOfExecutionOnFailureLeft()` Get the numberOfExecutionOnFailureLeft value.
`int`	`getProgress()` Return the latest progress value for this task.
`abstract int`	`getReplicationIndex()` When Control Flow actions are performed (see `Task.getFlowScript()`), some tasks are replicated.
`Map<String,String>`	`getRuntimeGenericInformation()` Returns a map of generic information, with replacement done from the runtime variables map
`Map<String,Serializable>`	`getRuntimeVariables()` Returns a map containing both scope variables and system variables
`long`	`getScheduledTime()` To get the scheduledTime
`Map<String,Serializable>`	`getScopeVariables()` Returns a map containing all scope variables defined in this Task (i.e.
`long`	`getStartTime()` To get the startTime
`TaskStatus`	`getStatus()` To get the status of this task
`Map<String,Serializable>`	`getSystemVariables()` Returns a map containing all variables defined by the system for this task, such as PA_JOB_ID, PA_USER, etc.
`abstract TaskInfo`	`getTaskInfo()` To get the taskInfo
`int`	`hashCode()`
`boolean`	`isTaskAlive()` Returns true if the task is alive (a task is alive when it's waiting to be executed or being executed
`abstract TaskState`	`replicate()` Replicates a task
`static void`	`setSortingBy(int sortBy)` Set the field to sort on.
`static void`	`setSortingOrder(int order)` Set the order for the next sort.
`String`	`toString()`
`abstract void`	`update(TaskInfo taskInfo)` To update this taskState using a taskInfo

Methods inherited from class org.ow2.proactive.scheduler.common.task.Task
addInputFiles, addInputFiles, addOutputFiles, addOutputFiles, addSelectionScript, display, getCleaningScript, getDescription, getFlowBlock, getFlowScript, getForkEnvironment, getInputFilesList, getNumberOfNodesNeeded, getOutputFilesList, getParallelEnvironment, getPostScript, getPreScript, getSelectionScripts, getTag, getUnresolvedVariables, getVariables, getVariablesOverriden, getWallTime, getWorkingDir, isFork, isParallel, isPreciousLogs, isPreciousResult, isRunAsMe, isWallTimeSet, setCleaningScript, setDescription, setFlowBlock, setFlowScript, setFork, setForkEnvironment, setName, setNumberOfNeededNodes, setParallelEnvironment, setPostScript, setPreciousLogs, setPreciousResult, setPreScript, setRunAsMe, setSelectionScript, setSelectionScripts, setTag, setUnresolvedVariables, setVariables, setWallTime, verifyVariableMap

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SORT_BY_ID
```
public static final int SORT_BY_ID
```
    Sorting constant, this will allow the user to sort the descriptor.
    
    See Also:
    
    Constant Field Values
  - SORT_BY_NAME
```
public static final int SORT_BY_NAME
```
    See Also:
    
    Constant Field Values
  - SORT_BY_STATUS
```
public static final int SORT_BY_STATUS
```
    See Also:
    
    Constant Field Values
  - SORT_BY_DESCRIPTION
```
public static final int SORT_BY_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - SORT_BY_EXECUTIONLEFT
```
public static final int SORT_BY_EXECUTIONLEFT
```
    See Also:
    
    Constant Field Values
  - SORT_BY_EXECUTIONONFAILURELEFT
```
public static final int SORT_BY_EXECUTIONONFAILURELEFT
```
    See Also:
    
    Constant Field Values
  - SORT_BY_STARTED_TIME
```
public static final int SORT_BY_STARTED_TIME
```
    See Also:
    
    Constant Field Values
  - SORT_BY_FINISHED_TIME
```
public static final int SORT_BY_FINISHED_TIME
```
    See Also:
    
    Constant Field Values
  - SORT_BY_HOST_NAME
```
public static final int SORT_BY_HOST_NAME
```
    See Also:
    
    Constant Field Values
  - SORT_BY_EXEC_DURATION
```
public static final int SORT_BY_EXEC_DURATION
```
    See Also:
    
    Constant Field Values
  - ASC_ORDER
```
public static final int ASC_ORDER
```
    See Also:
    
    Constant Field Values
  - DESC_ORDER
```
public static final int DESC_ORDER
```
    See Also:
    
    Constant Field Values
  - currentSort
```
protected static int currentSort
```
  - currentOrder
```
protected static int currentOrder
```
  - COMPARE_BY_FINISHED_TIME_ASC
```
public static final Comparator<TaskState> COMPARE_BY_FINISHED_TIME_ASC
```
- Constructor Detail
  - TaskState
```
public TaskState()
```
    ProActive default constructor
- Method Detail
  - update
```
public abstract void update(TaskInfo taskInfo)
```
    To update this taskState using a taskInfo
    
    Parameters:
    
    taskInfo - the taskInfo to set
  - getDependences
```
public abstract List<TaskState> getDependences()
```
    To get the dependences of this task. Return null if this task has no dependence.
    
    Returns:
    
    the dependences of this task
  - getDependencesList
```
public List<Task> getDependencesList()
```
    If the Task was submitted, a call to this method will throw a RuntimeException. The Dependence list should then be accessed through getDependences()
    
    Overrides:
    
    getDependencesList in class Task
    
    Returns:
    
    the the list of dependences of the task, or null if this task has been submitted
  - addDependence
```
public void addDependence(Task task)
```
    If the Task was submitted, a call to this method will throw a RuntimeException. Dependences cannot be added to a task at runtime.
    
    Overrides:
    
    addDependence in class Task
    
    Parameters:
    
    task - the parent task to add to this task.
    
    Throws:
    
    IllegalStateException - if this task was already submitted to the scheduler
  - addDependences
```
public void addDependences(List<Task> tasks)
```
    If the Task was submitted, a call to this method will throw a RuntimeException. Dependences cannot be added to a task at runtime.
    
    Overrides:
    
    addDependences in class Task
    
    Parameters:
    
    tasks - the parent tasks to add to this task.
    
    Throws:
    
    IllegalStateException - if this task was already submitted to the scheduler
  - setSortingBy
```
public static void setSortingBy(int sortBy)
```
    Set the field to sort on.
    
    Parameters:
    
    sortBy - the field on which the sort will be made.
  - setSortingOrder
```
public static void setSortingOrder(int order)
```
    Set the order for the next sort.
    
    Parameters:
    
    order - ASC_ORDER or DESC_ORDER
  - compareTo
```
public int compareTo(TaskState task)
```
    Specified by:
    
    compareTo in interface Comparable<TaskState>
    
    See Also:
    
    Comparable.compareTo(java.lang.Object)
  - getTaskInfo
```
public abstract TaskInfo getTaskInfo()
```
    To get the taskInfo
    
    Returns:
    
    the taskInfo
  - isTaskAlive
```
public boolean isTaskAlive()
```
    Returns true if the task is alive (a task is alive when it's waiting to be executed or being executed
    
    Returns:
    
    true if the task is alive
  - getFinishedTime
```
public long getFinishedTime()
```
    To get the finishedTime
    
    Returns:
    
    the finishedTime
  - getJobId
```
public JobId getJobId()
```
    To get the jobID
    
    Returns:
    
    the jobID
  - getStartTime
```
public long getStartTime()
```
    To get the startTime
    
    Returns:
    
    the startTime
  - getScheduledTime
```
public long getScheduledTime()
```
    To get the scheduledTime
    
    Returns:
    
    the scheduledTime
  - getId
```
public TaskId getId()
```
    To get the taskId
    
    Returns:
    
    the taskID
  - getStatus
```
public TaskStatus getStatus()
```
    To get the status of this task
    
    Returns:
    
    the status of this task
  - getProgress
```
public int getProgress()
```
    Return the latest progress value for this task. Progress value is ranged between 0 and 100.
    
    Returns:
    
    the latest progress value for this task.
  - getExecutionHostName
```
public String getExecutionHostName()
```
    Get the last execution HostName of the task.
    
    Returns:
    
    the last execution HostName.
  - getExecutionHostNameList
```
public String[] getExecutionHostNameList()
```
    To get the list of execution hosts name. The first element of the returned array is the most recent used host.
    
    Returns:
    
    the execution Host Name list.
  - getNumberOfExecutionLeft
```
public int getNumberOfExecutionLeft()
```
    Get the number of execution left.
    
    Returns:
    
    the number of execution left.
  - getNumberOfExecutionOnFailureLeft
```
public int getNumberOfExecutionOnFailureLeft()
```
    Get the numberOfExecutionOnFailureLeft value.
    
    Returns:
    
    the numberOfExecutionOnFailureLeft value.
  - getExecutionDuration
```
public long getExecutionDuration()
```
    Get the real task duration in millis. It is the CPU time used by the task not including communication and initialization. It also include time spent in Pre and Post scripts.
    
    Returns:
    
    the real task duration in millis
  - getMaxNumberOfExecutionOnFailure
```
public abstract int getMaxNumberOfExecutionOnFailure()
```
    Get the number of execution on failure allowed by the task.
    
    Returns:
    
    the number of execution on failure allowed by the task
  - getName
```
public String getName()
```
    Description copied from class: Task
    
    To get the name of this task.
    
    Overrides:
    
    getName in class Task
    
    Returns:
    
    the name of this task.
    
    See Also:
    
    Task.getName()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Task
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
    
    See Also:
    
    Object.hashCode()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - replicate
```
public abstract TaskState replicate()
                             throws Exception
```
    Replicates a task
    Deep copies all fields, does not share any reference
    
    Returns:
    
    the newly created task, cast as a TaskState
    
    Throws:
    
    Exception
  - getIterationIndex
```
public abstract int getIterationIndex()
```
    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.
    
    Returns:
    
    the iteration number of this task if it was replicated by a LOOP flow operation (>= 0)
  - getReplicationIndex
```
public abstract int getReplicationIndex()
```
    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.
    
    Returns:
    
    the replication number of this task if it was replicated by a REPLICATE flow operations (>= 0)
  - getScopeVariables
```
public Map<String,Serializable> getScopeVariables()
```
    Returns a map containing all scope variables defined in this Task (i.e. all task variables not inherited)
    
    Returns:
    
    map of variables
  - getSystemVariables
```
public Map<String,Serializable> getSystemVariables()
```
    Returns a map containing all variables defined by the system for this task, such as PA_JOB_ID, PA_USER, etc.
    
    Returns:
    
    map of variables
  - getRuntimeVariables
```
public Map<String,Serializable> getRuntimeVariables()
```
    Returns a map containing both scope variables and system variables
    
    Returns:
    
    map of variables
  - getRuntimeGenericInformation
```
public Map<String,String> getRuntimeGenericInformation()
```
    Returns a map of generic information, with replacement done from the runtime variables map

Class TaskState

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

SORT_BY_ID

SORT_BY_NAME

SORT_BY_STATUS

SORT_BY_DESCRIPTION

SORT_BY_EXECUTIONLEFT

SORT_BY_EXECUTIONONFAILURELEFT

SORT_BY_STARTED_TIME

SORT_BY_FINISHED_TIME

SORT_BY_HOST_NAME

SORT_BY_EXEC_DURATION

ASC_ORDER

DESC_ORDER

currentSort

currentOrder

COMPARE_BY_FINISHED_TIME_ASC

Constructor Detail

TaskState

Method Detail

update

getDependences

getDependencesList

addDependence

addDependences

setSortingBy

setSortingOrder

compareTo

getTaskInfo

isTaskAlive

getFinishedTime

getJobId

getStartTime

getScheduledTime

getId

getStatus

getProgress

getExecutionHostName

getExecutionHostNameList

getNumberOfExecutionLeft

getNumberOfExecutionOnFailureLeft

getExecutionDuration

getMaxNumberOfExecutionOnFailure

getName

toString

hashCode

equals

replicate

getIterationIndex

getReplicationIndex

getScopeVariables

getSystemVariables

getRuntimeVariables

getRuntimeGenericInformation