ITrigger Interface

Quartz.NET 3.0 API Documentation
The base interface with properties common to all ITriggers - use TriggerBuilder to instantiate an actual Trigger.

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

C#
public interface ITrigger : IComparable<ITrigger>

The ITrigger 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.
Public propertyDescription
Get or set the description given to the ITrigger instance by its creator (if any).
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.
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.

Public propertyHasMillisecondPrecision
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.

Public propertyJobKey
Public propertyKey
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.

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.
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.
Top
Methods

  NameDescription
Public methodClone
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.
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.

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

ITriggers have a TriggerKey associated with them, which should uniquely identify them within a single IScheduler.

ITriggers are the 'mechanism' by which IJob s are scheduled. Many ITrigger s can point to the same IJob, but a single ITrigger can only point to one IJob.

Triggers can 'send' parameters/data to IJobs by placing contents into the JobDataMap on the ITrigger.

See Also

Reference