ICalendar Interface

Quartz.NET 3.0 API Documentation
An interface to be implemented by objects that define spaces of time during which an associated ITrigger may (not) fire. Calendars do not define actual fire times, but rather are used to limit a ITrigger from firing on its normal schedule if necessary. Most Calendars include all times by default and allow the user to specify times to exclude.

Namespace:  Quartz
Assembly:  Quartz (in Quartz.dll) Version: 3.0.0
Syntax
C#
Copy
public interface ICalendar

The ICalendar type exposes the following members.

Properties
  NameDescription
Public propertyCalendarBase
Set a new base calendar or remove the existing one. Get the base calendar.
Public propertyDescription
Gets or sets a description for the ICalendar instance - may be useful for remembering/displaying the purpose of the calendar, though the description has no meaning to Quartz.
Top
Methods
  NameDescription
Public methodClone
Public methodGetNextIncludedTimeUtc
Determine the next UTC time that is 'included' by the Calendar after the given UTC time.
Public methodIsTimeIncluded
Determine whether the given UTC time is 'included' by the Calendar.
Top
Remarks
As such, it is often useful to think of Calendars as being used to exclude a block of time - as opposed to include a block of time. (i.e. the schedule "fire every five minutes except on Sundays" could be implemented with a ISimpleTrigger and a WeeklyCalendar which excludes Sundays)

Implementations MUST take care of being properly cloneable and Serializable.

See Also

Reference

Quartz Namespace