Task

java.lang.Object
- agi.parallel.infrastructure.Task

All Implemented Interfaces:

java.io.Serializable
```
public abstract class Task
extends java.lang.Object
implements java.io.Serializable
```
Represents an individual task in the system. The task provides the function to run remotely.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Task()

Constructors
Constructor and Description
`Task()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCompletedListener(CompletedListener listener)`
`void`	`addProgressUpdatedListener(ProgressUpdatedListener listener)`
`void`	`addStatusChangedListener(StatusChangedListener listener)`
`abstract void`	`execute()` Main entry point into Task when it is run on a Host.
`java.util.UUID`	`getId()` Gets the unique handle of task.
`boolean`	`getIsCancelling()` Gets a value indicating whether this task is cancelling.
`boolean`	`getIsFinishedTaskStatus()` Gets a value indicating whether this task has been finished.
`java.lang.String`	`getName()` Gets the display name of the task.
`java.util.Hashtable`	`getProperties()` Gets the properties of the task.
`java.lang.Object`	`getProperty(java.lang.String propertyName)` Returns property value by name.
`java.lang.Object`	`getResult()` Gets Task's execution result.
`java.lang.String`	`getStandardError()` Gets the standard error of the host that executed the task.
`java.lang.String`	`getStandardOutput()` Gets the standard output of the host that executed the task.
`java.lang.String`	`getTaskCancellationMessage()` Gets the optional task cancellation message.
`TaskCancellationReason`	`getTaskCancellationReason()` Gets the reason why the task was canceled.
`TaskStatus`	`getTaskStatus()` Gets the task status.
`void`	`removeProperty(java.lang.String propertyName)` Removes the property from the property bag.
`void`	`setName(java.lang.String value)` Sets the display name of the task.
`void`	`setProgress(int progress)` Sets progress of task.
`void`	`setProgress(int progress, java.lang.Object additionalInformation)` Sets progress of task.
`void`	`setProperty(java.lang.String propertyName, java.lang.Object value)` Sets properties on Task.
`void`	`setResult(java.lang.Object value)` Sets Task's execution result.
`java.lang.String`	`toString()`

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

- Constructor Detail
  - Task
```
public Task()
```
- Method Detail
  - addCompletedListener
```
public void addCompletedListener(CompletedListener listener)
```
  - addStatusChangedListener
```
public void addStatusChangedListener(StatusChangedListener listener)
```
  - addProgressUpdatedListener
```
public void addProgressUpdatedListener(ProgressUpdatedListener listener)
```
  - getResult
```
public java.lang.Object getResult()
```
    Gets Task's execution result. Result type must implement Serializable.
  - setResult
```
public void setResult(java.lang.Object value)
```
    Sets Task's execution result. Result type must implement Serializable.
  - getTaskStatus
```
public final TaskStatus getTaskStatus()
```
    Gets the task status.
  - getTaskCancellationReason
```
public final TaskCancellationReason getTaskCancellationReason()
```
    Gets the reason why the task was canceled.
  - getTaskCancellationMessage
```
public final java.lang.String getTaskCancellationMessage()
```
    Gets the optional task cancellation message.
  - getStandardOutput
```
public final java.lang.String getStandardOutput()
```
    Gets the standard output of the host that executed the task.
  - getStandardError
```
public final java.lang.String getStandardError()
```
    Gets the standard error of the host that executed the task.
  - getId
```
public final java.util.UUID getId()
```
    Gets the unique handle of task.
  - getName
```
public final java.lang.String getName()
```
    Gets the display name of the task.
  - setName
```
public final void setName(java.lang.String value)
```
    Sets the display name of the task.
  - getProperties
```
public final java.util.Hashtable getProperties()
```
    Gets the properties of the task.
  - getIsCancelling
```
public final boolean getIsCancelling()
```
    Gets a value indicating whether this task is cancelling. true if this instance is cancelling; otherwise, false.
  - getIsFinishedTaskStatus
```
public final boolean getIsFinishedTaskStatus()
```
    Gets a value indicating whether this task has been finished. Equivalent to calling TaskUtil.IsCompletedTaskStatus on the task's status. This is equivalent to testing that the task status is TaskStatus.Completed, TaskStatus.Failed, TaskStatus.TimedOut, TaskStatus.EnvironmentError, TaskStatus.Interrupted or TaskStatus.Canceled. true if this task is finished; otherwise, false.
  - execute
```
public abstract void execute()
```
    Main entry point into Task when it is run on a Host.
  - setProgress
```
public final void setProgress(int progress)
```
    Sets progress of task. This value will be returned with AGI.Parallel.Client.Job.TaskProgressUpdated event.
    
    Parameters:
    
    progress - The progress of task.
  - setProgress
```
public final void setProgress(int progress,
                              java.lang.Object additionalInformation)
```
    Sets progress of task. This value will be returned with AGI.Parallel.Client.Job.TaskProgressUpdated event. The additionalInformation value must be a primitive type. For example, string, integer, double, or byte[].
    
    Parameters:
    
    progress - The progress of task.
    
    additionalInformation - Aditional argument that will be marshalled to AGI.Parallel.Client.Job.TaskProgressUpdated event.
  - setProperty
```
public final void setProperty(java.lang.String propertyName,
                              java.lang.Object value)
```
    Sets properties on Task. You can find common values for properties using TaskProperties.
    
    Parameters:
    
    propertyName - Property Name.
    
    value - Property Value.
  - getProperty
```
public final java.lang.Object getProperty(java.lang.String propertyName)
```
    Returns property value by name. You can find common values for properties using TaskProperties.
    
    Parameters:
    
    propertyName - Name of Property.
    
    Returns:
    
    The value associated with the specified property.
  - removeProperty
```
public final void removeProperty(java.lang.String propertyName)
```
    Removes the property from the property bag. You can find common values for properties using TaskProperties.
    
    Parameters:
    
    propertyName - Name of the property to remove.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Task

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Task

Method Detail

addCompletedListener

addStatusChangedListener

addProgressUpdatedListener

getResult

setResult

getTaskStatus

getTaskCancellationReason

getTaskCancellationMessage

getStandardOutput

getStandardError

getId

getName

setName

getProperties

getIsCancelling

getIsFinishedTaskStatus

execute

setProgress

setProgress

setProperty

getProperty

removeProperty

toString