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
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
Name | Description | |
---|---|---|
SimpleTriggerImpl |
Create a SimpleTriggerImpl with no settings.
| |
SimpleTriggerImpl(String) |
Create a SimpleTriggerImpl that will occur immediately, and
not repeat.
| |
SimpleTriggerImpl(String, DateTimeOffset) |
Create a SimpleTriggerImpl that will occur at the given time,
and not repeat.
| |
SimpleTriggerImpl(String, String) |
Create a SimpleTriggerImpl that will occur immediately, and
not repeat.
| |
SimpleTriggerImpl(String, Int32, TimeSpan) |
Create a SimpleTriggerImpl that will occur immediately, and
repeat at the given interval the given number of times.
| |
SimpleTriggerImpl(String, String, DateTimeOffset) |
Create a SimpleTriggerImpl that will occur at the given time,
and not repeat.
| |
SimpleTriggerImpl(String, String, Int32, TimeSpan) |
Create a SimpleTriggerImpl that will occur immediately, and
repeat at the given interval the given number of times.
| |
SimpleTriggerImpl(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.
| |
SimpleTriggerImpl(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.
| |
SimpleTriggerImpl(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.
|
Properties
Name | Description | |
---|---|---|
CalendarName |
Get or set the ICalendar with the given name with
this Trigger. Use when setting to dis-associate a Calendar.
(Inherited from AbstractTrigger.) | |
Description |
Get or set the description given to the ITrigger instance by
its creator (if any).
(Inherited from AbstractTrigger.) | |
EndTimeUtc |
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.) | |
FinalFireTimeUtc |
Returns the final UTC time at which the ISimpleTrigger will
fire, if repeatCount is RepeatIndefinitely, null will be returned.
(Overrides AbstractTriggerFinalFireTimeUtc.)Note that the return time may be in the past. | |
FireInstanceId |
This method should not be used by the Quartz client.
(Inherited from AbstractTrigger.) | |
FullJobName | (Inherited from AbstractTrigger.) | |
FullName |
Returns the 'full name' of the ITrigger in the format
"group.name".
(Inherited from AbstractTrigger.) | |
Group |
Get the group of this ITrigger. If , Scheduler.DefaultGroup will be used.
(Inherited from AbstractTrigger.) | |
HasAdditionalProperties |
Gets a value indicating whether this instance has additional properties
that should be considered when for example saving to database.
(Inherited from AbstractTrigger.) | |
HasMillisecondPrecision |
Tells whether this Trigger instance can handle events
in millisecond precision.
(Overrides AbstractTriggerHasMillisecondPrecision.) | |
JobDataMap |
Get or set the JobDataMap that is associated with the
ITrigger.
(Inherited from AbstractTrigger.)Changes made to this map during job execution are not re-persisted, and in fact typically result in an illegal state. | |
JobGroup |
Gets or sets the name of the associated IJobDetail's
group. If set with , Scheduler.DefaultGroup will be used.
(Inherited from AbstractTrigger.) | |
JobKey | (Inherited from AbstractTrigger.) | |
JobName |
Get or set the name of the associated IJobDetail.
(Inherited from AbstractTrigger.) | |
Key |
Gets the key.
(Inherited from AbstractTrigger.) | |
MisfireInstruction |
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.
(Inherited from AbstractTrigger.)If not explicitly set, the default value is InstructionNotSet. | |
Name |
Get or sets the name of this ITrigger.
(Inherited from AbstractTrigger.) | |
Priority |
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.) | |
RepeatCount |
Get or set the number of times the SimpleTriggerImpl should
repeat, after which it will be automatically deleted.
| |
RepeatInterval |
Get or set the time interval at which the ISimpleTrigger should repeat.
| |
StartTimeUtc |
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.) | |
TimesTriggered |
Get or set the number of times the ISimpleTrigger has already
fired.
|
Methods
Name | Description | |
---|---|---|
Clone |
Creates a new object that is a copy of the current instance.
(Inherited from AbstractTrigger.) | |
CompareTo |
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.) | |
ComputeFirstFireTimeUtc |
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.
(Overrides AbstractTriggerComputeFirstFireTimeUtc(ICalendar).)After this method has been called, GetNextFireTimeUtc should return a valid answer. | |
ComputeNumTimesFiredBetween |
Computes the number of times fired between the two UTC date times.
| |
Equals(Object) | (Inherited from AbstractTrigger.) | |
Equals(AbstractTrigger) |
Trigger equality is based upon the equality of the TriggerKey.
(Inherited from AbstractTrigger.) | |
ExecutionComplete |
This method should not be used by the Quartz client.
(Inherited from AbstractTrigger.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetFireTimeAfter |
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).) | |
GetFireTimeBefore |
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.
| |
GetHashCode |
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.) | |
GetMayFireAgain |
Determines whether or not the ISimpleTrigger will occur
again.
(Overrides AbstractTriggerGetMayFireAgain.) | |
GetNextFireTimeUtc |
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.) | |
GetPreviousFireTimeUtc |
Returns the previous time at which the ISimpleTrigger fired.
If the trigger has not yet fired, will be
returned.
(Overrides AbstractTriggerGetPreviousFireTimeUtc.) | |
GetScheduleBuilder | (Overrides AbstractTriggerGetScheduleBuilder.) | |
GetTriggerBuilder | (Inherited from AbstractTrigger.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
SetNextFireTimeUtc | (Overrides AbstractTriggerSetNextFireTimeUtc(NullableDateTimeOffset).) | |
SetPreviousFireTimeUtc | (Overrides AbstractTriggerSetPreviousFireTimeUtc(NullableDateTimeOffset).) | |
ToString |
Return a simple string representation of this object.
(Inherited from AbstractTrigger.) | |
Triggered |
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).) | |
UpdateAfterMisfire |
Updates the ISimpleTrigger's state based on the
MisfireInstruction value that was selected when the ISimpleTrigger
was created.
(Overrides AbstractTriggerUpdateAfterMisfire(ICalendar).) | |
UpdateWithNewCalendar |
Updates the instance with new calendar.
(Overrides AbstractTriggerUpdateWithNewCalendar(ICalendar, TimeSpan).) | |
Validate |
Validates whether the properties of the IJobDetail are
valid for submission into a IScheduler.
(Overrides AbstractTriggerValidate.) | |
ValidateMisfireInstruction |
Validates the misfire instruction.
(Overrides AbstractTriggerValidateMisfireInstruction(Int32).) |
Fields
Name | Description | |
---|---|---|
RepeatIndefinitely |
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.
|
See Also