org.quartz
Interface QuartzCalendar

All Superinterfaces:
java.io.Serializable

public interface QuartzCalendar
extends java.io.Serializable

An interface to be implemented by objects that define spaces of time that should be included or excluded from a Trigger's normal 'firing' schedule.

Author:
James House, Juergen Donnerstag

Field Summary
static int MONTH
           
 
Method Summary
 QuartzCalendar getBaseCalendar()
          Get the base calendar.
 java.lang.String getDescription()
          Return the description given to the QuartzCalendar instance by its creator (if any).
 long getNextIncludedTime(long timeStamp)
          Determine the next time (in milliseconds) that is 'included' by the QuartzCalendar after the given time.
 boolean isTimeIncluded(long timeStamp)
          Determine whether the given time (in milliseconds) is 'included' by the QuartzCalendar.
 boolean isVolatile()
          Whether or not the QuartzCalendar should be persisted in the JobStore for re-use after program restarts.
 void setBaseCalendar(QuartzCalendar baseCalendar)
          Set a new base calendar or remove the existing one.
 void setDescription(java.lang.String description)
          Set a description for the QuartzCalendar instance - may be useful for remembering/displaying the purpose of the calendar, though the description has no meaning to Quartz.
 void setVolatility(boolean volatility)
          Set whether or not the QuartzCalendar should be persisted in the JobStore for re-use after program restarts.
 

Field Detail

MONTH

public static final int MONTH
See Also:
Constant Field Values
Method Detail

setBaseCalendar

public void setBaseCalendar(QuartzCalendar baseCalendar)

Set a new base calendar or remove the existing one.


getBaseCalendar

public QuartzCalendar getBaseCalendar()

Get the base calendar. Will be null, if not set.


isVolatile

public boolean isVolatile()

Whether or not the QuartzCalendar should be persisted in the JobStore for re-use after program restarts.

If not explicitly set, the default value should be false.

Returns:
true if the QuartzCalendar should be garbage collected along with the Scheduler.

setVolatility

public void setVolatility(boolean volatility)

Set whether or not the QuartzCalendar should be persisted in the JobStore for re-use after program restarts.


isTimeIncluded

public boolean isTimeIncluded(long timeStamp)

Determine whether the given time (in milliseconds) is 'included' by the QuartzCalendar.


getNextIncludedTime

public long getNextIncludedTime(long timeStamp)

Determine the next time (in milliseconds) that is 'included' by the QuartzCalendar after the given time.


getDescription

public java.lang.String getDescription()

Return the description given to the QuartzCalendar instance by its creator (if any).

Returns:
null if no description was set.

setDescription

public void setDescription(java.lang.String description)

Set a description for the QuartzCalendar instance - may be useful for remembering/displaying the purpose of the calendar, though the description has no meaning to Quartz.



Copyright James House (c) 2001-2004