Keel 2.1RC2

org.keel.services.schedule
Interface Scheduler

All Known Implementing Classes:
QuartzScheduler

public interface Scheduler

A scheduler is a class that handles requests for execution of other classes and methods at specific times in the future, either once, or on a specified repetitive basis

Version:
$Revision: 1.5 $ $Date: 2003/08/28 03:18:55 $
Author:
Michael Nash Created on Sep 13, 2002

Field Summary
static java.lang.String ROLE
           
 
Method Summary
 ScheduledRequest getRequest(int requestNumber)
           
 java.util.Set getRequests()
          Return the set of request ID's currently being handled by this scheduler
 void remove(ScheduledRequest s)
          Removed the specified request from the schedule, if it was scheduled.
 void schedule(ScheduledRequest s)
          Schedule a new request.
 void start()
          Start the scheduler.
 void stop()
          Stop the scheduler.
 

Field Detail

ROLE

public static final java.lang.String ROLE
See Also:
Constant Field Values
Method Detail

start

public void start()
           throws NestedException
Start the scheduler. Ignored if the scheduler is already running. If there are tasks scheduled for times that have already passed, they are started now.

Throws:
NestedException

stop

public void stop()
          throws NestedException
Stop the scheduler. Depending on the implementation of the scheduler, this may or may not result in any currently scheduled tasks being stored for later operation.

Throws:
NestedException

schedule

public void schedule(ScheduledRequest s)
              throws NestedException
Schedule a new request. If the given request was already scheduled (as determined by it's request id number) then re-schedule it with the new parameters given.

Throws:
NestedException

remove

public void remove(ScheduledRequest s)
            throws NestedException
Removed the specified request from the schedule, if it was scheduled.

Throws:
NestedException

getRequests

public java.util.Set getRequests()
                          throws NestedException
Return the set of request ID's currently being handled by this scheduler

Returns:
A set of Integer values, each representing a scheduled request being handled by this scheduler.
Throws:
NestedException

getRequest

public ScheduledRequest getRequest(int requestNumber)
                            throws NestedException
Throws:
NestedException

Keel 2.1RC2

Please see keelframework.org for information about new Keel releases.