IOperableTrigger MembersQuartz.NET API Documentation

The IOperableTrigger type exposes the following members.

Methods

  NameDescription
Public methodClone
Creates a new object that is a copy of the current instance.
(Inherited from ICloneable.)
Public methodCompareTo
Compares the current object with another object of the same type.
(Inherited from IComparable ITrigger .)
Public methodComputeFirstFireTimeUtc
This method should not be used by the Quartz client.
Public methodExecutionComplete
This method should not be used by the Quartz client.
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.)
Public methodSetNextFireTimeUtc
Public methodSetPreviousFireTimeUtc
Public methodTriggered
This method should not be used by the Quartz client.
Public methodUpdateAfterMisfire
This method should not be used by the Quartz client.

To be implemented by the concrete classes that extend this class.

The implementation should update the ITrigger's state based on the MISFIRE_INSTRUCTION_XXX that was selected when the ITrigger was created.

Public methodUpdateWithNewCalendar
This method should not be used by the Quartz client.

The implementation should update the ITrigger's state based on the given new version of the associated ICalendar (the state should be updated so that it's next fire time is appropriate given the Calendar's new settings).

Public methodValidate
Validates whether the properties of the IJobDetail are valid for submission into a IScheduler.
Top
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 propertyCalendarName
Associate the ICalendar with the given name with this Trigger.
(Inherited from IMutableTrigger.)
Public propertyDescription
Get or set the description given to the ITrigger instance by its creator (if any).
(Inherited from ITrigger.)
Public propertyDescription
Set a description for the ITrigger instance - may be useful for remembering/displaying the purpose of the trigger, though the description has no meaning to Quartz.
(Inherited from IMutableTrigger.)
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 propertyEndTimeUtc

Set the time at which the ITrigger should quit repeating - regardless of any remaining repeats (based on the trigger's particular repeat settings).

(Inherited from IMutableTrigger.)
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 propertyFireInstanceId
This method should not be used by the Quartz client.
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 propertyJobDataMap
Set the JobDataMap to be associated with the ITrigger.
(Inherited from IMutableTrigger.)
Public propertyJobKey (Inherited from ITrigger.)
Public propertyJobKey (Inherited from IMutableTrigger.)
Public propertyKey (Inherited from ITrigger.)
Public propertyKey (Inherited from IMutableTrigger.)
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 propertyMisfireInstruction
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 MisfireInstruction.XXX constants that may be passed to this method.
(Inherited from IMutableTrigger.)
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 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 IMutableTrigger.)
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 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.

Setting a value in the past may cause a new trigger to compute a first fire time that is in the past, which may cause an immediate misfire of the trigger.

ew DateTimeOffset StartTimeUtc { get; set; }
(Inherited from IMutableTrigger.)
Top
See Also