IOperableTrigger Interface

Quartz.NET 3.0 API Documentation

Internal interface for managing triggers. This interface should not be used by the Quartz client.

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

Syntax

public interface IOperableTrigger : IMutableTrigger, 
	ITrigger, IComparable<ITrigger>

The IOperableTrigger type exposes the following members.

Properties

�	Name	Description
	CalendarName	Associate the ICalendar with the given name with this Trigger. (Inherited from IMutableTrigger.)
	Description	Set a description for the ITrigger instance - may be useful for remembering/displaying the purpose of the trigger, though the description has no meaning to Quartz. (Inherited from IMutableTrigger.)
	EndTimeUtc	Set the time at which the ITrigger should quit repeating - regardless of any remaining repeats (based on the trigger's particular repeat settings). (Inherited from IMutableTrigger.)
	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. (Inherited from ITrigger.)
	FireInstanceId	This method should not be used by the Quartz client.
	HasMillisecondPrecision	(Inherited from ITrigger.)
	JobDataMap	Set the JobDataMap to be associated with the ITrigger. (Inherited from IMutableTrigger.)
	JobKey	(Inherited from IMutableTrigger.)
	Key	(Inherited from IMutableTrigger.)
	MisfireInstruction	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 MisfireInstruction.XXX constants that may be passed to this method. (Inherited from IMutableTrigger.)
	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 IMutableTrigger.)
	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. Setting a value in the past may cause a new trigger to compute a first fire time that is in the past, which may cause an immediate misfire of the trigger. ew DateTimeOffset StartTimeUtc { get; set; } (Inherited from IMutableTrigger.)

Top

Methods

�	Name	Description
	Clone	(Inherited from ITrigger.)
	CompareTo	Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. (Inherited from IComparableITrigger.)
	ComputeFirstFireTimeUtc	This method should not be used by the Quartz client.
	ExecutionComplete	This method should not be used by the Quartz client.
	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. (Inherited from ITrigger.)
	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. (Inherited from ITrigger.)
	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). (Inherited from ITrigger.)
	GetPreviousFireTimeUtc	Returns the previous time at which the ITrigger fired. If the trigger has not yet fired, will be returned. (Inherited from ITrigger.)
	GetScheduleBuilder	Get a IScheduleBuilder that is configured to produce a schedule identical to this trigger's schedule. (Inherited from ITrigger.)
	GetTriggerBuilder	Get a TriggerBuilder that is configured to produce a trigger identical to this one. (Inherited from ITrigger.)
	SetNextFireTimeUtc
	SetPreviousFireTimeUtc
	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.

Top

Reference

Quartz.Spi Namespace