|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An interface to be implemented by objects that define spaces of time
that should be included or excluded from a
's
normal 'firing' schedule.Trigger
Field Summary | |
static int |
MONTH
|
Method Summary | |
Calendar |
getBaseCalendar()
Get the base calendar. |
java.lang.String |
getDescription()
Return the description given to the Calendar instance
by its creator (if any). |
long |
getNextIncludedTime(long timeStamp)
Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time. |
boolean |
isTimeIncluded(long timeStamp)
Determine whether the given time (in milliseconds) is 'included' by the Calendar. |
void |
setBaseCalendar(Calendar baseCalendar)
Set a new base calendar or remove the existing one. |
void |
setDescription(java.lang.String description)
Set a description for the Calendar instance - may be
useful for remembering/displaying the purpose of the calendar, though
the description has no meaning to Quartz. |
Field Detail |
public static final int MONTH
Method Detail |
public void setBaseCalendar(Calendar baseCalendar)
Set a new base calendar or remove the existing one.
public Calendar getBaseCalendar()
Get the base calendar. Will be null, if not set.
public boolean isTimeIncluded(long timeStamp)
Determine whether the given time (in milliseconds) is 'included' by the Calendar.
public long getNextIncludedTime(long timeStamp)
Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time.
public java.lang.String getDescription()
Return the description given to the Calendar
instance
by its creator (if any).
public void setDescription(java.lang.String description)
Set a description for the Calendar
instance - may be
useful for remembering/displaying the purpose of the calendar, though
the description has no meaning to Quartz.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |