AnnualCalendar Class

Quartz.NET 3.0 API Documentation
This implementation of the Calendar excludes a set of days of the year. You may use it to exclude bank holidays which are on the same date every year.
Inheritance Hierarchy

SystemObject
  Quartz.Impl.CalendarBaseCalendar
    Quartz.Impl.CalendarAnnualCalendar

Namespace:  Quartz.Impl.Calendar
Assembly:  Quartz (in Quartz.dll) Version: 3.0.0
Syntax

C#
[SerializableAttribute]
public class AnnualCalendar : BaseCalendar

The AnnualCalendar type exposes the following members.

Constructors

  NameDescription
Public methodAnnualCalendar
Constructor
Public methodAnnualCalendar(ICalendar)
Constructor
Protected methodAnnualCalendar(SerializationInfo, StreamingContext)
Serialization constructor.
Top
Properties

  NameDescription
Public propertyCalendarBase
Set a new base calendar or remove the existing one
(Inherited from BaseCalendar.)
Public propertyDaysExcluded
Gets or sets the days to be excluded by this calendar.
Public propertyDescription
Gets or sets the description given to the ICalendar instance by its creator (if any).
(Inherited from BaseCalendar.)
Public propertyTimeZone
Gets or sets the time zone.
(Inherited from BaseCalendar.)
Top
Methods

  NameDescription
Public methodClone (Overrides BaseCalendarClone.)
Protected methodCloneFields (Inherited from BaseCalendar.)
Public methodEquals(Object) (Overrides BaseCalendarEquals(Object).)
Public methodEquals(AnnualCalendar)
Public methodEquals(BaseCalendar) (Inherited from BaseCalendar.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode (Overrides BaseCalendarGetHashCode.)
Public methodGetNextIncludedTimeUtc
Determine the next UTC time (in milliseconds) that is 'included' by the Calendar after the given time. Return the original value if timeStampUtc is included. Return 0 if all days are excluded.

Note that this Calendar is only has full-day precision.

(Overrides BaseCalendarGetNextIncludedTimeUtc(DateTimeOffset).)
Public methodGetObjectData (Overrides BaseCalendarGetObjectData(SerializationInfo, StreamingContext).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsDayExcluded
Return true, if day is defined to be excluded.
Public methodIsTimeIncluded
Determine whether the given UTC time (in milliseconds) is 'included' by the Calendar.

Note that this Calendar is only has full-day precision.

(Overrides BaseCalendarIsTimeIncluded(DateTimeOffset).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetDayExcluded
Redefine a certain day to be excluded (true) or included (false).
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also

Reference