Keel 2.1RC2

org.keel.services.schedule
Interface ScheduledRequest

All Known Subinterfaces:
QuartzScheduledRequest
All Known Implementing Classes:
QuartzScheduledRequestImpl

public interface ScheduledRequest

A ScheduledRequest is a request to perform some method of a specified class at a later time, either once or on a repetitive basis. The parameters used to set up a request are quite intentionally similar to the "crontab" command on Unix/Linux-type systems

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

Field Summary
static java.lang.String ROLE
           
 
Method Summary
 java.lang.String getExpression()
          Return the formatted CRON-tab expression that is the cumulative of the previously set seconds, minutes, hours, day-of-month/week, year fields
 java.util.Date getNextDate()
          Return a Date when this object is next scheduled to be run (if at all).
 int getNumber()
          Get the sequential request number provided by the scheduler when this task was scheduled
 ModelRequest getRequest()
          Get the ModelRequest that is to be/has been scheduled
 void setDate(java.util.Date d)
          Set this request to execute at the specified date/time (once)
 void setDaysOfMonth(java.lang.String s)
           
 void setDaysOfWeek(java.lang.String s)
           
 void setHours(java.lang.String s)
           
 void setMinutes(java.lang.String s)
          Specify a minute or set of minutes, where each minute (0 thru 59, inclusive) indicates a minute of the hour at which this request will be run.
 void setMonths(java.lang.String s)
           
 void setNumber(int newNumber)
          The scheduler (only) sets the identifying number of this request
 void setPriority(int newPrio)
          Set the priority of this task.
 void setRequest(ModelRequest req)
          Specify a ModelRequest to be executed at the specified date/time(s)
 void setSeconds(java.lang.String s)
           
 void setYears(java.lang.String s)
           
 

Field Detail

ROLE

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

getNumber

public int getNumber()
Get the sequential request number provided by the scheduler when this task was scheduled


setMinutes

public void setMinutes(java.lang.String s)
Specify a minute or set of minutes, where each minute (0 thru 59, inclusive) indicates a minute of the hour at which this request will be run. Multiple minutes are seperated by commas (e.g. "5,10" and ranges may be specified, e.g. "10-20" would mean every minutes of the hour between 10 and 20, inclusive. A value of "*" means every minute of the hour.


setHours

public void setHours(java.lang.String s)

setDaysOfMonth

public void setDaysOfMonth(java.lang.String s)

setMonths

public void setMonths(java.lang.String s)

setYears

public void setYears(java.lang.String s)

setSeconds

public void setSeconds(java.lang.String s)

setDaysOfWeek

public void setDaysOfWeek(java.lang.String s)

setDate

public void setDate(java.util.Date d)
Set this request to execute at the specified date/time (once)


setRequest

public void setRequest(ModelRequest req)
Specify a ModelRequest to be executed at the specified date/time(s)


getRequest

public ModelRequest getRequest()
Get the ModelRequest that is to be/has been scheduled


setNumber

public void setNumber(int newNumber)
The scheduler (only) sets the identifying number of this request


setPriority

public void setPriority(int newPrio)
Set the priority of this task. Tasks with higher priority will run before tasks with lower priority if multiple tasks are ready at once to run


getNextDate

public java.util.Date getNextDate()
Return a Date when this object is next scheduled to be run (if at all). Null indicates that there is no schedule, and a date in the past indicates that the most current scheduled run is in the pas


getExpression

public java.lang.String getExpression()
Return the formatted CRON-tab expression that is the cumulative of the previously set seconds, minutes, hours, day-of-month/week, year fields


Keel 2.1RC2

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