CronTrigger MembersQuartz.NET API Documentation

The CronTrigger type exposes the following members.

Constructors

  NameDescription
Public methodCronTrigger 
Create a CronTrigger with no settings.
Public methodCronTrigger(String)
Create a CronTrigger with the given name and default group.
Public methodCronTrigger(String, String)
Create a CronTrigger with the given name and group.
Public methodCronTrigger(String, String, String)
Create a CronTrigger with the given name, group and expression.
Public methodCronTrigger(String, String, String, String)
Create a CronTrigger with the given name and group, and associated with the identified JobDetail.
Public methodCronTrigger(String, String, String, String, String)
Create a CronTrigger with the given name and group, associated with the identified JobDetail, and with the given "cron" expression.
Public methodCronTrigger(String, String, String, String, String, TimeZoneInfo)
Create a CronTrigger with the given name and group, associated with the identified JobDetail, and with the given "cron" expression resolved with respect to the TimeZone.
Public methodCronTrigger(String, String, String, String, DateTime, Nullable DateTime , String)
Create a CronTrigger that will occur at the given time, until the given end time.

If null, the start-time will also be set to the current time, the time zone will be set the the system's default.

Public methodCronTrigger(String, String, String, String, DateTime, Nullable DateTime , String, TimeZoneInfo)
Create a CronTrigger with fire time dictated by the resolved with respect to the specified occuring from the startTimeUtc until the given .
Top
Methods

  NameDescription
Public methodAddTriggerListener
Add the specified name of a ITriggerListener to the end of the Trigger's list of listeners.
(Inherited from Trigger.)
Public methodClearAllTriggerListeners
Remove all ITriggerListeners from the Trigger.
(Inherited from Trigger.)
Public methodClone
Clones this instance.
(Overrides Trigger Clone .)
Public methodCompareTo
Compare the next fire time of this Trigger to that of another.
(Inherited from Trigger.)
Public methodComputeFirstFireTimeUtc
Called by the scheduler at the time a Trigger is first added to the scheduler, in order to have the Trigger compute its first fire time, based on any associated calendar.

After this method has been called, GetNextFireTimeUtc  should return a valid answer.

(Overrides Trigger ComputeFirstFireTimeUtc(ICalendar).)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Trigger.)
Public methodExecutionComplete
This method should not be used by the Quartz client.
(Inherited from Trigger.)
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 methodGetExpressionSummary
Gets the expression summary.
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.
(Overrides Trigger GetFireTimeAfter(Nullable DateTime ).)
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.
(Inherited from Trigger.)
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.

(Overrides Trigger GetMayFireAgain .)
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).
(Overrides Trigger GetNextFireTimeUtc .)
Public methodGetPreviousFireTimeUtc
Returns the previous time at which the Trigger fired. If the trigger has not yet fired,   will be returned.
(Overrides Trigger GetPreviousFireTimeUtc .)
Protected methodGetTimeAfter
Gets the next time to fire after the given time.
Protected methodGetTimeBefore
NOT YET IMPLEMENTED: Returns the time before the given time that this CronTrigger will fire.
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.
(Inherited from Trigger.)
Public methodSetNextFireTime
Sets the next fire time.

This method should not be invoked by client code.

Public methodSetPreviousFireTime
Sets the previous fire time.

This method should not be invoked by client code.

Public methodToString
Return a simple string representation of this object.
(Inherited from Trigger.)
Public methodTriggered
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).
(Overrides Trigger Triggered(ICalendar).)
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.

(Overrides Trigger UpdateAfterMisfire(ICalendar).)
Public methodUpdateWithNewCalendar
Updates the trigger with new calendar.
(Overrides Trigger UpdateWithNewCalendar(ICalendar, TimeSpan).)
Public methodValidate
Validates whether the properties of the JobDetail are valid for submission into a IScheduler.
(Inherited from Trigger.)
Protected methodValidateMisfireInstruction
Validates the misfire instruction.
(Overrides Trigger ValidateMisfireInstruction(Int32).)
Public methodWillFireOn(DateTime)

Determines whether the date and (optionally) time of the given Calendar instance falls on a scheduled fire-time of this trigger.

Equivalent to calling WillFireOn(DateTime, Boolean).

Public methodWillFireOn(DateTime, Boolean)
Determines whether the date and (optionally) time of the given Calendar instance falls on a scheduled fire-time of this trigger.

Note that the value returned is NOT validated against the related ICalendar (if any).

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 Trigger.)
Public propertyCronExpression
Set the CronExpression to the given one. The TimeZone on the passed-in CronExpression over-rides any that was already set on the Trigger.
Public propertyCronExpressionString
Gets or sets the cron expression string.
Public propertyDescription
Get or set the description given to the Trigger instance by its creator (if any).
(Inherited from Trigger.)
Public propertyEndTimeUtc
Get or sets the time at which the CronTrigger should quit repeating - even if repeastCount isn't yet satisfied.
(Overrides Trigger EndTimeUtc.)
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.

(Overrides Trigger FinalFireTimeUtc.)
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.

(Inherited from Trigger.)
Public propertyFullJobName
Returns the 'full name' of the IJob that the Trigger points to, in the format "group.name".
(Inherited from Trigger.)
Public propertyFullName
Returns the 'full name' of the Trigger in the format "group.name".
(Inherited from Trigger.)
Public propertyGroup
Get the group of this Trigger. If  , Scheduler.DefaultGroup will be used.
(Inherited from Trigger.)
Public propertyHasAdditionalProperties
Gets a value indicating whether this instance has additional properties that should be considered when for example saving to database.
(Inherited from Trigger.)
Public propertyHasMillisecondPrecision
Tells whether this Trigger instance can handle events in millisecond precision.
(Overrides Trigger HasMillisecondPrecision.)
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.

(Inherited from Trigger.)
Public propertyJobGroup
Gets or sets the name of the associated JobDetail's group. If set with  , Scheduler.DefaultGroup will be used.
(Inherited from Trigger.)
Public propertyJobName
Get or set the name of the associated JobDetail.
(Inherited from Trigger.)
Public propertyKey
Gets the key.
(Inherited from Trigger.)
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.

(Inherited from Trigger.)
Public propertyName
Get or sets the name of this Trigger.
(Inherited from 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.
(Inherited from Trigger.)
Public propertyStartTimeUtc
Returns the date/time on which the trigger may begin firing. This defines the initial boundary for trigger firings the trigger will not fire prior to this date and time.
(Overrides Trigger StartTimeUtc.)
Public propertyTimeZone
Sets the time zone for which the CronExpression of this CronTrigger will be resolved.
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.
(Inherited from Trigger.)
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  .

(Inherited from Trigger.)
Top
See Also