ca.eandb.jdcp.job

Class TaskDescription

java.lang.Object

ca.eandb.jdcp.job.TaskDescription

All Implemented Interfaces:

Serializable

public final class TaskDescription
extends Object
implements Serializable

A description of a task assigned by a JobMasterService.

Author:

Brad Kimmel

See Also:

TaskService.requestTask(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
TaskDescription(UUID jobId, int taskId, Object task) Initializes the task description.

Method Summary

Modifier and Type	Method and Description
UUID	getJobId() Gets the UUID of the job whose TaskWorker should perform this task.
ca.eandb.util.rmi.Serialized<Object>	getTask() Gets the Object describing the task to be performed.
int	getTaskId() The ID of the task to be performed.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskDescription

public TaskDescription(UUID jobId,
                       int taskId,
                       Object task)

Initializes the task description.

Parameters:

jobId - The UUID of the job that the task is for.

taskId - The ID of the task to be performed.

task - An Object describing the task to be performed. This should be passed to TaskWorker.performTask.

See Also:

TaskWorker.performTask(Object, ca.eandb.util.progress.ProgressMonitor)

Method Detail

getTask

public ca.eandb.util.rmi.Serialized<Object> getTask()

Gets the Object describing the task to be performed. This should be passed to TaskWorker.performTask for the TaskWorker corresponding to the job with the UUID given by getJobId(). The TaskWorker may be obtained by calling TaskService.getTaskWorker(UUID).

Returns:

The Object describing the task to be performed.

See Also:

getJobId(), TaskWorker.performTask(Object, ca.eandb.util.progress.ProgressMonitor), TaskService.getTaskWorker(UUID)

getJobId

public UUID getJobId()

Gets the UUID of the job whose TaskWorker should perform this task. Call TaskService.getTaskWorker(UUID) to get the TaskWorker to use to perform this task.

Returns:

The UUID of the job that this task is associated with.

See Also:

TaskService.getTaskWorker(UUID)

getTaskId

public int getTaskId()

The ID of the task to be performed. This should be passed back to JobMasterService.submitTaskResults when submitting the results of this task.

Returns:

The ID of the task to be performed.

See Also:

TaskService.submitTaskResults(UUID, int, Serialized)