Trigger MembersQuartz.NET API Documentation

The Trigger type exposes the following members.

Constructors

  NameDescription
Public methodTrigger 
Create a Trigger with no specified name, group, or JobDetail.
Protected methodTrigger(String)
Create a Trigger with the given name, and default group.
Public methodTrigger(String, String)
Create a Trigger with the given name, and group.
Public methodTrigger(String, String, String, String)
Create a Trigger with the given name, and group.
Top
Methods

  NameDescription
Public methodAddTriggerListener
Add the specified name of a ITriggerListener to the end of the Trigger's list of listeners.
Public methodClearAllTriggerListeners
Remove all ITriggerListeners from the Trigger.
Public methodClone
Creates a new object that is a copy of the current instance.
Public methodCompareTo
Compare the next fire time of this Trigger to that of another.
Public methodComputeFirstFireTimeUtc
This method should not be used by the Quartz client.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Overrides Object Equals(Object).)
Public methodExecutionComplete
This method should not be used by the Quartz client.
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetFireTimeAfter
Returns the next time at which the Trigger will fire, after the given time. If the trigger will not fire after the given time,   will be returned.
Public methodGetHashCode
Serves as a hash function for a particular type. GetHashCode  is suitable for use in hashing algorithms and data structures like a hash table.
(Overrides Object GetHashCode .)
Public methodGetMayFireAgain
Used by the IScheduler to determine whether or not it is possible for this Trigger to fire again.

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

Public methodGetNextFireTimeUtc
Returns the next time at which the Trigger 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 Trigger fired. If the trigger has not yet fired,   will be returned.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemoveTriggerListener
Remove the specified name of a ITriggerListener from the Trigger's list of listeners.
Public methodToString
Return a simple string representation of this object.
(Overrides Object ToString .)
Public methodTriggered
This method should not be used by the Quartz client.

Called when the IScheduler has decided to 'fire' the trigger (Execute the associated IJob), in order to give the Trigger a chance to update itself for its next triggering (if any).

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 Trigger's state based on the MISFIRE_INSTRUCTION_XXX that was selected when the Trigger was created.

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

The implementation should update the Trigger'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 JobDetail are valid for submission into a IScheduler.
Protected methodValidateMisfireInstruction
Validates the misfire instruction.
Top
Fields

  NameDescription
Public fieldStatic memberDefaultPriority
The default value for priority.
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.
Public propertyDescription
Get or set the description given to the Trigger instance by its creator (if any).
Public propertyEndTimeUtc
Returns 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. 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 Trigger will fire, if the Trigger will repeat indefinitely, null will be returned.

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

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

Usable by IJobStore implementations, in order to facilitate 'recognizing' instances of fired Trigger s as their jobs complete execution.

Public propertyFullJobName
Returns the 'full name' of the IJob that the Trigger points to, in the format "group.name".
Public propertyFullName
Returns the 'full name' of the Trigger in the format "group.name".
Public propertyGroup
Get the group of this Trigger. If  , Scheduler.DefaultGroup will be used.
Public propertyHasAdditionalProperties
Gets a value indicating whether this instance has additional properties that should be considered when for example saving to database.
Public propertyHasMillisecondPrecision
Tells whether this Trigger instance can handle events in millisecond precision.
Public propertyJobDataMap
Get or set the JobDataMap that is associated with the Trigger.

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

Public propertyJobGroup
Gets or sets the name of the associated JobDetail's group. If set with  , Scheduler.DefaultGroup will be used.
Public propertyJobName
Get or set the name of the associated JobDetail.
Public propertyKey
Gets the key.
Public propertyMisfireInstruction
Get or set the instruction the IScheduler should be given for handling misfire situations for this Trigger- the concrete Trigger type that you are using will have defined a set of additional MISFIRE_INSTRUCTION_XXX constants that may be passed to this method.

If not explicitly set, the default value is InstructionNotSet.

Public propertyName
Get or sets the name of this Trigger.
Public propertyPriority
The priority of a Trigger acts as a tie breaker such that if two Triggers 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.
Public propertyTriggerListenerNames
Returns an array of String s containing the names of all ITriggerListeners assigned to the Trigger, in the order in which they should be notified.
Public propertyVolatile
Whether or not the Trigger should be persisted in the IJobStore for re-use after program restarts.

If not explicitly set, the default value is  .

Top
See Also