org.apache.jetspeed.scheduler
Interface Scheduler

All Known Implementing Classes:

AbstractScheduler, MemoryBasedScheduler

public interface Scheduler

ScheduleService interface.

Version:

$Id: Scheduler.java 516448 2007-03-09 16:25:47Z ate $

Author:

Dave Bryson

Field Summary

static String

SERVICE_NAME

Method Summary

void	addJob(JobEntry je) Add a new job to the queue.
JobEntry	getJob(int oid) Get a specific Job from Storage.
List	listJobs() List jobs in the queue.
void	removeJob(JobEntry je) Remove a job from the queue.
void	updateJob(JobEntry je) Modify a Job.

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

getJob

JobEntry getJob(int oid)
                throws Exception

Get a specific Job from Storage.

Parameters:

oid - The int id for the job.

Returns:

A JobEntry.

Throws:

Exception, - a generic exception.

Exception

addJob

void addJob(JobEntry je)
            throws Exception

Add a new job to the queue.

Parameters:

je - A JobEntry with the job to add.

Throws:

Exception, - a generic exception.

Exception

updateJob

void updateJob(JobEntry je)
               throws Exception

Modify a Job.

Parameters:

je - A JobEntry with the job to modify

Throws:

Exception, - a generic exception.

Exception

removeJob

void removeJob(JobEntry je)
               throws Exception

Remove a job from the queue.

Parameters:

je - A JobEntry with the job to remove.

Throws:

Exception, - a generic exception.

Exception

listJobs

List listJobs()

List jobs in the queue. This is used by the scheduler UI.

Returns:

A List of jobs.