IDailyTimeIntervalTrigger Interface

Quartz.NET 3.0 API Documentation
A ITrigger that is used to fire a IJobDetail based upon daily repeating time intervals.

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

C#
public interface IDailyTimeIntervalTrigger : ITrigger, 
	IComparable<ITrigger>

The IDailyTimeIntervalTrigger type exposes the following members.

Properties

  NameDescription
Public propertyCalendarName
Get or set the ICalendar with the given name with this Trigger. Use when setting to dis-associate a Calendar.
(Inherited from ITrigger.)
Public propertyDaysOfWeek
The days of the week upon which to fire.
Public propertyDescription
Get or set the description given to the ITrigger instance by its creator (if any).
(Inherited from ITrigger.)
Public propertyEndTimeOfDay
The time of day to complete firing at the given interval.
Public propertyEndTimeUtc
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.)
Public propertyFinalFireTimeUtc
Returns the last UTC time at which the ITrigger will fire, if the Trigger will repeat indefinitely, null will be returned.

Note that the return time *may* be in the past.

(Inherited from ITrigger.)
Public propertyHasMillisecondPrecision (Inherited from ITrigger.)
Public propertyJobDataMap
Get or set the JobDataMap that is associated with the ITrigger.

Changes made to this map during job execution are not re-persisted, and in fact typically result in an illegal state.

(Inherited from ITrigger.)
Public propertyJobKey (Inherited from ITrigger.)
Public propertyKey (Inherited from ITrigger.)
Public propertyMisfireInstruction
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.

If not explicitly set, the default value is InstructionNotSet.

(Inherited from ITrigger.)
Public propertyPriority
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.)
Public propertyRepeatCount
Get the number of times for interval this trigger should repeat, after which it will be automatically deleted.
Public propertyRepeatInterval
Get the time interval that will be added to the IDailyTimeIntervalTrigger's fire time (in the set repeat interval unit) in order to calculate the time of the next trigger repeat.
Public propertyRepeatIntervalUnit
Get the interval unit - the time unit on with the interval applies. The only intervals that are valid for this type of trigger are Second, Minute, and Hour
Public propertyStartTimeOfDay
The time of day to start firing at the given interval.
Public propertyStartTimeUtc
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.)
Public propertyTimesTriggered
Get the number of times the IDailyTimeIntervalTrigger has already fired.
Public propertyTimeZone
Gets the time zone within which time calculations related to this trigger will be performed.
Top
Methods

  NameDescription
Public methodClone (Inherited from ITrigger.)
Public methodCompareTo
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.)
Public methodGetFireTimeAfter
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.)
Public methodGetMayFireAgain
Used by the IScheduler to determine whether or not it is possible for this ITrigger to fire again.

If the returned value is then the IScheduler may remove the ITrigger from the IJobStore.

(Inherited from ITrigger.)
Public methodGetNextFireTimeUtc
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.)
Public methodGetPreviousFireTimeUtc
Returns the previous time at which the ITrigger fired. If the trigger has not yet fired, will be returned.
(Inherited from ITrigger.)
Public methodGetScheduleBuilder
Get a IScheduleBuilder that is configured to produce a schedule identical to this trigger's schedule.
(Inherited from ITrigger.)
Public methodGetTriggerBuilder
Get a TriggerBuilder that is configured to produce a trigger identical to this one.
(Inherited from ITrigger.)
Top
Remarks

The trigger will fire every N (see RepeatInterval ) seconds, minutes or hours (see RepeatIntervalUnit) during a given time window on specified days of the week.

For example#1, a trigger can be set to fire every 72 minutes between 8:00 and 11:00 everyday. It's fire times be 8:00, 9:12, 10:24, then next day would repeat: 8:00, 9:12, 10:24 again.

For example#2, a trigger can be set to fire every 23 minutes between 9:20 and 16:47 Monday through Friday.

On each day, the starting fire time is reset to startTimeOfDay value, and then it will add repeatInterval value to it until the endTimeOfDay is reached. If you set daysOfWeek values, then fire time will only occur during those week days period.

The default values for fields if not set are: startTimeOfDay defaults to 00:00:00, the endTimeOfDay default to 23:59:59, and daysOfWeek is default to every day. The startTime default to current time-stamp now, while endTime has not value.

If startTime is before startTimeOfDay, then it has no affect. Else if startTime after startTimeOfDay, then the first fire time for that day will be normal startTimeOfDay incremental values after startTime value. Same reversal logic is applied to endTime with endTimeOfDay.

See Also

Reference