AbstractTrigger Class

Quartz.NET 3.0 API Documentation

The base abstract class to be extended by all triggers.

Inheritance Hierarchy

SystemObject
��Quartz.Impl.TriggersAbstractTrigger
��Quartz.Impl.TriggersCalendarIntervalTriggerImpl
��Quartz.Impl.TriggersCronTriggerImpl
��Quartz.Impl.TriggersDailyTimeIntervalTriggerImpl
��Quartz.Impl.TriggersSimpleTriggerImpl

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

Syntax

Copy

[SerializableAttribute]
public abstract class AbstractTrigger : IOperableTrigger, 
	IMutableTrigger, ITrigger, IComparable<ITrigger>, IEquatable<AbstractTrigger>

The AbstractTrigger type exposes the following members.

Constructors

�	Name	Description
	AbstractTrigger	Create a ITrigger with no specified name, group, or IJobDetail.
	AbstractTrigger(String)	Create a ITrigger with the given name, and default group.
	AbstractTrigger(String, String)	Create a ITrigger with the given name, and group.
	AbstractTrigger(String, String, String, String)	Create a ITrigger with the given name, and group.

Top

Properties

�	Name	Description
	CalendarName	Get or set the ICalendar with the given name with this Trigger. Use when setting to dis-associate a Calendar.
	Description	Get or set the description given to the ITrigger instance by its creator (if any).
	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.
	FinalFireTimeUtc	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.
	FireInstanceId	This method should not be used by the Quartz client.
	FullJobName	Returns the 'full name' of the IJob that the ITrigger points to, in the format "group.name".
	FullName	Returns the 'full name' of the ITrigger in the format "group.name".
	Group	Get the group of this ITrigger. If , Scheduler.DefaultGroup will be used.
	HasAdditionalProperties	Gets a value indicating whether this instance has additional properties that should be considered when for example saving to database.
	HasMillisecondPrecision	Tells whether this Trigger instance can handle events in millisecond precision.
	JobDataMap	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.
	JobGroup	Gets or sets the name of the associated IJobDetail's group. If set with , Scheduler.DefaultGroup will be used.
	JobKey
	JobName	Get or set the name of the associated IJobDetail.
	Key	Gets the key.
	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. If not explicitly set, the default value is InstructionNotSet.
	Name	Get or sets the name of this ITrigger.
	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.
	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.

Top

Methods

�	Name	Description
	Clone	Creates a new object that is a copy of the current instance.
	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.
	ComputeFirstFireTimeUtc	This method should not be used by the Quartz client.
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Overrides ObjectEquals(Object).)
	Equals(AbstractTrigger)	Trigger equality is based upon the equality of the TriggerKey.
	ExecutionComplete	This method should not be used by the Quartz client.
	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 time at which the ITrigger will fire, after the given time. If the trigger will not fire after 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. (Overrides ObjectGetHashCode.)
	GetMayFireAgain	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.
	GetNextFireTimeUtc	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).
	GetPreviousFireTimeUtc	Returns the previous time at which the ITrigger fired. If the trigger has not yet fired, will be returned.
	GetScheduleBuilder
	GetTriggerBuilder
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetNextFireTimeUtc
	SetPreviousFireTimeUtc
	ToString	Return a simple string representation of this object. (Overrides ObjectToString.)
	Triggered	This method should not be used by the Quartz client.
	UpdateAfterMisfire	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.
	UpdateWithNewCalendar	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).
	Validate	Validates whether the properties of the IJobDetail are valid for submission into a IScheduler.
	ValidateMisfireInstruction	Validates the misfire instruction.

Top

Remarks

ITriggers have a name and group associated with them, which should uniquely identify them within a single IScheduler.

ITriggers are the 'mechanism' by which IJob s are scheduled. Many ITrigger s can point to the same IJob, but a single ITrigger can only point to one IJob.

Triggers can 'send' parameters/data to IJobs by placing contents into the JobDataMap on the ITrigger.

Reference

Quartz.Impl.Triggers Namespace

QuartzISimpleTrigger

QuartzICronTrigger

QuartzIDailyTimeIntervalTrigger

AbstractTriggerJobDataMap

QuartzIJobExecutionContext