ca.eandb.jdcp.server.scheduling

Interface TaskScheduler

All Known Implementing Classes:

PrioritySerialTaskScheduler

public interface TaskScheduler

Represents an object that is responsible for determine in what order to serve tasks to worker clients.

Author:

Brad Kimmel

Method Summary

Modifier and Type	Method and Description
void	add(TaskDescription task) Adds a task to be scheduled.
boolean	contains(UUID jobId, int taskId) Determines if the specified task exists.
TaskDescription	get(UUID jobId, int taskId) Retrieves the specified task.
TaskDescription	getNextTask() Gets the next task to be served.
TaskDescription	remove(UUID jobId, int taskId) Removes a task from the schedule.
void	removeJob(UUID jobId) Removes all tasks from the schedule that are associated with the specified job.
void	setJobPriority(UUID jobId, int priority) Sets the priority of a job.

Method Detail

setJobPriority

void setJobPriority(UUID jobId,
                    int priority)

Sets the priority of a job. The job priority is a hint to the scheduler which it may use to determine the order in which tasks are served.

Parameters:

jobId - The UUID identifying the job for which to set the priority.

priority - The priority to set for the specified job.

add

void add(TaskDescription task)

Adds a task to be scheduled.

Parameters:

task - An TaskDescription describing the task to be performed.

remove

TaskDescription remove(UUID jobId,
                       int taskId)

Removes a task from the schedule.

Parameters:

jobId - The UUID identifying the job associated with the task to be removed.

taskId - The identifier for the task to be removed.

Returns:

The TaskDescription describing the specified task.

get

TaskDescription get(UUID jobId,
                    int taskId)

Retrieves the specified task.

Parameters:

jobId - The UUID identifying the job associated with the task to retrieve.

taskId - The identifier for the task to be retrieved.

Returns:

The TaskDescription describing the specified task, or null if no such task exists.

contains

boolean contains(UUID jobId,
                 int taskId)

Determines if the specified task exists.

Parameters:

jobId - The UUID identifying the job associated with the task to retrieve.

taskId - The identifier for the task to be retrieved.

Returns:

A value indicating if the specified task exists.

getNextTask

TaskDescription getNextTask()

Gets the next task to be served.

Returns:

A TaskDescription describing the next task to be served.

See Also:

TaskDescription

removeJob

void removeJob(UUID jobId)

Removes all tasks from the schedule that are associated with the specified job.

Parameters:

jobId - The UUID identifying the job for which all tasks are to be removed.