A ITrigger that is used to fire a IJobDetail
based upon repeating calendar time intervals.
Namespace: Quartz
Assembly: Quartz (in Quartz.dll) Version: 3.0.0
Syntax
C#
public interface ICalendarIntervalTrigger : ITrigger, IComparable<ITrigger>
The ICalendarIntervalTrigger type exposes the following members.
Properties
Name | Description | |
---|---|---|
CalendarName |
Get or set the ICalendar with the given name with
this Trigger. Use when setting to dis-associate a Calendar.
(Inherited from ITrigger.) | |
Description |
Get or set the description given to the ITrigger instance by
its creator (if any).
(Inherited from ITrigger.) | |
EndTimeUtc |
Gets and sets the date/time on which the trigger must stop firing. This
defines the final boundary for trigger firings ? the trigger will
not fire after to this date and time. If this value is null, no end time
boundary is assumed, and the trigger can continue indefinitely.
(Inherited from ITrigger.) | |
FinalFireTimeUtc |
Returns the last UTC time at which the ITrigger will fire, if
the Trigger will repeat indefinitely, null will be returned.
(Inherited from ITrigger.)Note that the return time *may* be in the past. | |
HasMillisecondPrecision | (Inherited from ITrigger.) | |
JobDataMap |
Get or set the JobDataMap that is associated with the
ITrigger.
(Inherited from ITrigger.)Changes made to this map during job execution are not re-persisted, and in fact typically result in an illegal state. | |
JobKey | (Inherited from ITrigger.) | |
Key | (Inherited from ITrigger.) | |
MisfireInstruction |
Get or set the instruction the IScheduler should be given for
handling misfire situations for this ITrigger- the
concrete ITrigger type that you are using will have
defined a set of additional MISFIRE_INSTRUCTION_XXX
constants that may be set to this property.
(Inherited from ITrigger.)If not explicitly set, the default value is InstructionNotSet. | |
PreserveHourOfDayAcrossDaylightSavings |
If intervals are a day or greater, this property (set to true) will
cause the firing of the trigger to always occur at the same time of day,
(the time of day of the startTime) regardless of daylight saving time
transitions. Default value is false.
| |
Priority |
The priority of a ITrigger acts as a tie breaker such that if
two ITriggers have the same scheduled fire time, then Quartz
will do its best to give the one with the higher priority first access
to a worker thread.
(Inherited from ITrigger.) | |
RepeatInterval |
Get the time interval that will be added to the ICalendarIntervalTrigger's
fire time (in the set repeat interval unit) in order to calculate the time of the
next trigger repeat.
| |
RepeatIntervalUnit |
Get or set the interval unit - the time unit on with the interval applies.
| |
SkipDayIfHourDoesNotExist |
If intervals are a day or greater, and
preserveHourOfDayAcrossDaylightSavings property is set to true, and the
hour of the day does not exist on a given day for which the trigger
would fire, the day will be skipped and the trigger advanced a second
interval if this property is set to true. Defaults to false.
| |
StartTimeUtc |
The time at which the trigger's scheduling should start. May or may not
be the first actual fire time of the trigger, depending upon the type of
trigger and the settings of the other properties of the trigger. However
the first actual first time will not be before this date.
(Inherited from ITrigger.) | |
TimesTriggered |
Get the number of times the ICalendarIntervalTrigger has already fired.
| |
TimeZone |
Gets the time zone within which time calculations related to this trigger will be performed.
|
Methods
Name | Description | |
---|---|---|
Clone | (Inherited from ITrigger.) | |
CompareTo | Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. (Inherited from IComparableITrigger.) | |
GetFireTimeAfter |
Returns the next time at which the ITrigger will fire,
after the given time. If the trigger will not fire after the given time,
will be returned.
(Inherited from ITrigger.) | |
GetMayFireAgain |
Used by the IScheduler to determine whether or not
it is possible for this ITrigger to fire again.
(Inherited from ITrigger.)If the returned value is then the IScheduler may remove the ITrigger from the IJobStore. | |
GetNextFireTimeUtc |
Returns the next time at which the ITrigger is scheduled to fire. If
the trigger will not fire again, will be returned. Note that
the time returned can possibly be in the past, if the time that was computed
for the trigger to next fire has already arrived, but the scheduler has not yet
been able to fire the trigger (which would likely be due to lack of resources
e.g. threads).
(Inherited from ITrigger.) | |
GetPreviousFireTimeUtc |
Returns the previous time at which the ITrigger fired.
If the trigger has not yet fired, will be returned.
(Inherited from ITrigger.) | |
GetScheduleBuilder |
Get a IScheduleBuilder that is configured to produce a
schedule identical to this trigger's schedule.
(Inherited from ITrigger.) | |
GetTriggerBuilder |
Get a TriggerBuilder that is configured to produce a
trigger identical to this one.
(Inherited from ITrigger.) |
See Also