This implementation of the Calendar excludes (or includes - see below) a
specified time range each day.
Inheritance Hierarchy
Quartz.Impl.CalendarBaseCalendar
Quartz.Impl.CalendarDailyCalendar
Namespace: Quartz.Impl.Calendar
Assembly: Quartz (in Quartz.dll) Version: 3.0.0
Syntax
C#
[SerializableAttribute] public class DailyCalendar : BaseCalendar
The DailyCalendar type exposes the following members.
Constructors
Name | Description | |
---|---|---|
DailyCalendar(DateTime, DateTime) |
Create a DailyCalendar with a time range defined by the
specified DateTimes and no
baseCalendar. The Calendars are subject to the following
considerations:
| |
DailyCalendar(Int64, Int64) |
Create a DailyCalendar with a time range defined by the
specified values and no baseCalendar. The values are
subject to the following considerations:
| |
DailyCalendar(SerializationInfo, StreamingContext) |
Serialization constructor.
| |
DailyCalendar(String, String) |
Create a DailyCalendar with a time range defined by the
specified strings and no baseCalendar.
rangeStartingTime and rangeEndingTime
must be in the format "HH:MM[:SS[:mmm]]" where:
| |
DailyCalendar(ICalendar, DateTime, DateTime) |
Create a DailyCalendar with a time range defined by the
specified DateTimes and the specified
baseCalendar. The Calendars are subject to the following
considerations:
| |
DailyCalendar(ICalendar, Int64, Int64) |
Create a DailyCalendar with a time range defined by the
specified values and the specified baseCalendar. The values
are subject to the following considerations:
| |
DailyCalendar(ICalendar, String, String) |
Create a DailyCalendar with a time range defined by the
specified strings and the specified baseCalendar.
rangeStartingTime and rangeEndingTime
must be in the format "HH:MM[:SS[:mmm]]" where:
| |
DailyCalendar(Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32) |
Create a DailyCalendar with a time range defined by the
specified values and no baseCalendar. Values are subject to
the following validations:
| |
DailyCalendar(ICalendar, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32) |
Create a DailyCalendar with a time range defined by the
specified values and the specified baseCalendar. Values are
subject to the following validations:
|
Properties
Name | Description | |
---|---|---|
CalendarBase |
Set a new base calendar or remove the existing one
(Inherited from BaseCalendar.) | |
Description |
Gets or sets the description given to the ICalendar instance by
its creator (if any).
(Inherited from BaseCalendar.) | |
InvertTimeRange |
Indicates whether the time range represents an inverted time range (see
class description).
| |
RangeEndingTime | ||
RangeStartingTime | ||
TimeZone |
Gets or sets the time zone.
(Inherited from BaseCalendar.) |
Methods
Name | Description | |
---|---|---|
Clone | (Overrides BaseCalendarClone.) | |
CloneFields | (Inherited from BaseCalendar.) | |
Equals(Object) | (Overrides BaseCalendarEquals(Object).) | |
Equals(BaseCalendar) | (Inherited from BaseCalendar.) | |
Equals(DailyCalendar) | ||
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | (Overrides BaseCalendarGetHashCode.) | |
GetNextIncludedTimeUtc |
Determine the next time (in milliseconds) that is 'included' by the
Calendar after the given time. Return the original value if timeStamp is
included. Return 0 if all days are excluded.
(Overrides BaseCalendarGetNextIncludedTimeUtc(DateTimeOffset).) | |
GetObjectData | (Overrides BaseCalendarGetObjectData(SerializationInfo, StreamingContext).) | |
GetTimeRangeEndingTimeUtc |
Returns the end time of the time range of the day
specified in timeUtc | |
GetTimeRangeStartingTimeUtc |
Returns the start time of the time range of the day
specified in timeUtc.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
IsTimeIncluded |
Determine whether the given time is 'included' by the
Calendar.
(Overrides BaseCalendarIsTimeIncluded(DateTimeOffset).) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
SetTimeRange(DateTime, DateTime) |
Sets the time range for the DailyCalendar to the times
represented in the specified DateTimes.
| |
SetTimeRange(Int64, Int64) |
Sets the time range for the DailyCalendar to the times
represented in the specified values.
| |
SetTimeRange(String, String) |
Sets the time range for the DailyCalendar to the times
represented in the specified Strings.
| |
SetTimeRange(Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32) |
Sets the time range for the DailyCalendar to the times
represented in the specified values.
| |
ToString | (Overrides ObjectToString.) |
Remarks
Note when using DailyCalendar, it behaves on the same principals as, for example, WeeklyCalendar defines a set of days that are excluded every week. Likewise, DailyCalendar defines a set of times that are excluded every day.
See Also