SimpleTriggerImpl Class

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

SystemObject
  Quartz.Impl.TriggersAbstractTrigger
    Quartz.Impl.TriggersSimpleTriggerImpl

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

C#
[SerializableAttribute]
public class SimpleTriggerImpl : AbstractTrigger, 
	ISimpleTrigger, ITrigger, IComparable<ITrigger>

The SimpleTriggerImpl type exposes the following members.

Constructors

  NameDescription
Public methodSimpleTriggerImpl
Create a SimpleTriggerImpl with no settings.
Public methodSimpleTriggerImpl(String)
Create a SimpleTriggerImpl that will occur immediately, and not repeat.
Public methodSimpleTriggerImpl(String, DateTimeOffset)
Create a SimpleTriggerImpl that will occur at the given time, and not repeat.
Public methodSimpleTriggerImpl(String, String)
Create a SimpleTriggerImpl that will occur immediately, and not repeat.
Public methodSimpleTriggerImpl(String, Int32, TimeSpan)
Create a SimpleTriggerImpl that will occur immediately, and repeat at the given interval the given number of times.
Public methodSimpleTriggerImpl(String, String, DateTimeOffset)
Create a SimpleTriggerImpl that will occur at the given time, and not repeat.
Public methodSimpleTriggerImpl(String, String, Int32, TimeSpan)
Create a SimpleTriggerImpl that will occur immediately, and repeat at the given interval the given number of times.
Public methodSimpleTriggerImpl(String, DateTimeOffset, NullableDateTimeOffset, Int32, TimeSpan)
Create a SimpleTriggerImpl that will occur at the given time, and repeat at the given interval the given number of times, or until the given end time.
Public methodSimpleTriggerImpl(String, String, DateTimeOffset, NullableDateTimeOffset, Int32, TimeSpan)
Create a SimpleTriggerImpl that will occur at the given time, and repeat at the given interval the given number of times, or until the given end time.
Public methodSimpleTriggerImpl(String, String, String, String, DateTimeOffset, NullableDateTimeOffset, Int32, TimeSpan)
Create a SimpleTriggerImpl that will occur at the given time, fire the identified IJob and repeat at the given interval the given number of times, or until the given end time.
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 AbstractTrigger.)
Public propertyDescription
Get or set the description given to the ITrigger instance by its creator (if any).
(Inherited from AbstractTrigger.)
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 AbstractTrigger.)
Public propertyFinalFireTimeUtc
Returns the final UTC time at which the ISimpleTrigger will fire, if repeatCount is RepeatIndefinitely, null will be returned.

Note that the return time may be in the past.

(Overrides AbstractTriggerFinalFireTimeUtc.)
Public propertyFireInstanceId
This method should not be used by the Quartz client.
(Inherited from AbstractTrigger.)
Public propertyFullJobName
Returns the 'full name' of the IJob that the ITrigger points to, in the format "group.name".
(Inherited from AbstractTrigger.)
Public propertyFullName
Returns the 'full name' of the ITrigger in the format "group.name".
(Inherited from AbstractTrigger.)
Public propertyGroup
Get the group of this ITrigger. If , Scheduler.DefaultGroup will be used.
(Inherited from AbstractTrigger.)
Public propertyHasAdditionalProperties
Gets a value indicating whether this instance has additional properties that should be considered when for example saving to database.
(Inherited from AbstractTrigger.)
Public propertyHasMillisecondPrecision
Tells whether this Trigger instance can handle events in millisecond precision.
(Overrides AbstractTriggerHasMillisecondPrecision.)
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 AbstractTrigger.)
Public propertyJobGroup
Gets or sets the name of the associated IJobDetail's group. If set with , Scheduler.DefaultGroup will be used.
(Inherited from AbstractTrigger.)
Public propertyJobKey (Inherited from AbstractTrigger.)
Public propertyJobName
Get or set the name of the associated IJobDetail.
(Inherited from AbstractTrigger.)
Public propertyKey
Gets the key.
(Inherited from AbstractTrigger.)
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 passed to this method.

If not explicitly set, the default value is InstructionNotSet.

(Inherited from AbstractTrigger.)
Public propertyName
Get or sets the name of this ITrigger.
(Inherited from AbstractTrigger.)
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 AbstractTrigger.)
Public propertyRepeatCount
Get or set the number of times the SimpleTriggerImpl 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 AbstractTrigger.)
Public propertyTimesTriggered
Get or set the number of times the ISimpleTrigger has already fired.
Top
Methods

  NameDescription
Public methodClone
Creates a new object that is a copy of the current instance.
(Inherited from AbstractTrigger.)
Public methodCompareTo
Compare the next fire time of this ITrigger to that of another by comparing their keys, or in other words, sorts them according to the natural (i.e. alphabetical) order of their keys.
(Inherited from AbstractTrigger.)
Public methodComputeFirstFireTimeUtc
Called by the scheduler at the time a ITrigger is first added to the scheduler, in order to have the ITrigger compute its first fire time, based on any associated calendar.

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

(Overrides AbstractTriggerComputeFirstFireTimeUtc(ICalendar).)
Public methodComputeNumTimesFiredBetween
Computes the number of times fired between the two UTC date times.
Public methodEquals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from AbstractTrigger.)
Public methodEquals(AbstractTrigger)
Trigger equality is based upon the equality of the TriggerKey.
(Inherited from AbstractTrigger.)
Public methodExecutionComplete
This method should not be used by the Quartz client.
(Inherited from AbstractTrigger.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetFireTimeAfter
Returns the next UTC time at which the ISimpleTrigger will fire, after the given UTC time. If the trigger will not fire after the given time, will be returned.
(Overrides AbstractTriggerGetFireTimeAfter(NullableDateTimeOffset).)
Public methodGetFireTimeBefore
Returns the last UTC time at which the ISimpleTrigger will fire, before the given time. If the trigger will not fire before 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.
(Inherited from AbstractTrigger.)
Public methodGetMayFireAgain
Determines whether or not the ISimpleTrigger will occur again.
(Overrides AbstractTriggerGetMayFireAgain.)
Public methodGetNextFireTimeUtc
Returns the next time at which the ISimpleTrigger will fire. If the trigger will not fire again, will be returned. The value returned is not guaranteed to be valid until after the ITrigger has been added to the scheduler.
(Overrides AbstractTriggerGetNextFireTimeUtc.)
Public methodGetPreviousFireTimeUtc
Returns the previous time at which the ISimpleTrigger fired. If the trigger has not yet fired, will be returned.
(Overrides AbstractTriggerGetPreviousFireTimeUtc.)
Public methodGetScheduleBuilder (Overrides AbstractTriggerGetScheduleBuilder.)
Public methodGetTriggerBuilder (Inherited from AbstractTrigger.)
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 methodSetNextFireTimeUtc (Overrides AbstractTriggerSetNextFireTimeUtc(NullableDateTimeOffset).)
Public methodSetPreviousFireTimeUtc (Overrides AbstractTriggerSetPreviousFireTimeUtc(NullableDateTimeOffset).)
Public methodToString
Return a simple string representation of this object.
(Inherited from AbstractTrigger.)
Public methodTriggered
Called when the IScheduler has decided to 'fire' the trigger (Execute the associated IJob), in order to give the ITrigger a chance to update itself for its next triggering (if any).
(Overrides AbstractTriggerTriggered(ICalendar).)
Public methodUpdateAfterMisfire
Updates the ISimpleTrigger's state based on the MisfireInstruction value that was selected when the ISimpleTrigger was created.
(Overrides AbstractTriggerUpdateAfterMisfire(ICalendar).)
Public methodUpdateWithNewCalendar
Updates the instance with new calendar.
(Overrides AbstractTriggerUpdateWithNewCalendar(ICalendar, TimeSpan).)
Public methodValidate
Validates whether the properties of the IJobDetail are valid for submission into a IScheduler.
(Overrides AbstractTriggerValidate.)
Protected methodValidateMisfireInstruction
Validates the misfire instruction.
(Overrides AbstractTriggerValidateMisfireInstruction(Int32).)
Top
Fields

  NameDescription
Public fieldStatic memberRepeatIndefinitely
Used to indicate the 'repeat count' of the trigger is indefinite. Or in other words, the trigger should repeat continually until the trigger's ending timestamp.
Top
See Also

Reference