org.proteios.core
Interface ManageableJobQueueReadOnlyInterface

All Known Subinterfaces:

ManageableJobQueueInterface

public interface ManageableJobQueueReadOnlyInterface

An interface for a job queue class, restricted to methods that do not modify the job queue when called.

Author:

olle

Method Summary

boolean	contains(JobData jobData) Checks if the queue contains a job item.
String	getDescription() Get the job queue class description string.
List<Job.ExecutionTime>	getExecutionTimeList() Get the execution time list.
String	getId() Get the job queue class id string.
JobData	getJob(int listIndex) Get job specified by list index number in queue.
JobData	getNextJob() Get next (first) job in queue, without modifying the queue.
boolean	isEmpty() Checks if the queue is empty.
int	size() Returns the size of the queue.

Method Detail

getId

String getId()

Get the job queue class id string.

Returns:

String The job queue class id string.

getDescription

String getDescription()

Get the job queue class description string.

Returns:

String The job queue class description string.

getExecutionTimeList

List<Job.ExecutionTime> getExecutionTimeList()

Get the execution time list. This is the list of execution time categories supported by the job queue class for automatic addition of a job to the job queue. A job must have an estimated execution time included in the list to be automatically loaded to the job queue. A job queue manager may override this using public method void addToQueue(int jobId).

Returns:

List The execution time list.

isEmpty

boolean isEmpty()

Checks if the queue is empty.

Returns:

boolean True if the queue is empty, else false.

size

int size()

Returns the size of the queue.

Returns:

int The size of the queue.

contains

boolean contains(JobData jobData)

Checks if the queue contains a job item.

Parameters:

jobData - JobData The job item to check for.

Returns:

boolean True if the queue contains the job item, else false.

getNextJob

JobData getNextJob()

Get next (first) job in queue, without modifying the queue.

Returns:

JobData The job data at the head of the queue, or null if not found.

getJob

JobData getJob(int listIndex)

Get job specified by list index number in queue.

Parameters:

listIndex - int Index number in list for job in queue.

Returns:

JobData The job data with specified list index number in queue, or null if not found.