ISimpleTrigger Interface

Quartz.NET 3.0 API Documentation
A ITrigger that is used to fire a IJob at a given moment in time, and optionally repeated at a specified interval.

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

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

The ISimpleTrigger 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 propertyDescription
Get or set the description given to the ITrigger instance by its creator (if any).
(Inherited from ITrigger.)
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 or set the number of times the ISimpleTrigger should repeat, after which it will be automatically deleted.
Public propertyRepeatInterval
Get or set the time interval at which the ISimpleTrigger should repeat.
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 or set the number of times the ISimpleTrigger has already fired.
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
See Also

Reference