Interface OperableTrigger
-
- All Superinterfaces:
java.lang.Cloneable
,java.lang.Comparable<Trigger>
,MutableTrigger
,java.io.Serializable
,Trigger
- All Known Implementing Classes:
AbstractTrigger
,CalendarIntervalTriggerImpl
,CronTriggerImpl
,DailyTimeIntervalTriggerImpl
,SimpleTriggerImpl
public interface OperableTrigger extends MutableTrigger
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.quartz.Trigger
Trigger.CompletedExecutionInstruction, Trigger.TriggerState, Trigger.TriggerTimeComparator
-
-
Field Summary
-
Fields inherited from interface org.quartz.Trigger
DEFAULT_PRIORITY, MISFIRE_INSTRUCTION_IGNORE_MISFIRE_POLICY, MISFIRE_INSTRUCTION_SMART_POLICY, serialVersionUID
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Date
computeFirstFireTime(Calendar calendar)
This method should not be used by the Quartz client.Trigger.CompletedExecutionInstruction
executionComplete(JobExecutionContext context, JobExecutionException result)
This method should not be used by the Quartz client.java.lang.String
getFireInstanceId()
This method should not be used by the Quartz client.void
setFireInstanceId(java.lang.String id)
This method should not be used by the Quartz client.void
setNextFireTime(java.util.Date nextFireTime)
void
setPreviousFireTime(java.util.Date previousFireTime)
void
triggered(Calendar calendar)
This method should not be used by the Quartz client.void
updateAfterMisfire(Calendar cal)
This method should not be used by the Quartz client.void
updateWithNewCalendar(Calendar cal, long misfireThreshold)
This method should not be used by the Quartz client.void
validate()
Validates whether the properties of theJobDetail
are valid for submission into aScheduler
.-
Methods inherited from interface org.quartz.spi.MutableTrigger
clone, setCalendarName, setDescription, setEndTime, setJobDataMap, setJobKey, setKey, setMisfireInstruction, setPriority, setStartTime
-
Methods inherited from interface org.quartz.Trigger
compareTo, equals, getCalendarName, getDescription, getEndTime, getFinalFireTime, getFireTimeAfter, getJobDataMap, getJobKey, getKey, getMisfireInstruction, getNextFireTime, getPreviousFireTime, getPriority, getScheduleBuilder, getStartTime, getTriggerBuilder, mayFireAgain
-
-
-
-
Method Detail
-
triggered
void triggered(Calendar calendar)
This method should not be used by the Quartz client.
Called when the
has decided to 'fire' the trigger (execute the associatedScheduler
Job
), in order to give theTrigger
a chance to update itself for its next triggering (if any).
-
computeFirstFireTime
java.util.Date computeFirstFireTime(Calendar calendar)
This method should not be used by the Quartz client.
Called by the scheduler at the time a
Trigger
is first added to the scheduler, in order to have theTrigger
compute its first fire time, based on any associated calendar.After this method has been called,
getNextFireTime()
should return a valid answer.- Returns:
- the first time at which the
Trigger
will be fired by the scheduler, which is also the same valuegetNextFireTime()
will return (until after the first firing of theTrigger
).
-
executionComplete
Trigger.CompletedExecutionInstruction executionComplete(JobExecutionContext context, JobExecutionException result)
This method should not be used by the Quartz client.
Called after the
has executed theScheduler
associated with theJobDetail
Trigger
in order to get the final instruction code from the trigger.- Parameters:
context
- is theJobExecutionContext
that was used by theJob
'sexecute(xx)
method.result
- is theJobExecutionException
thrown by theJob
, if any (may be null).- Returns:
- one of the
CompletedExecutionInstruction
constants. - See Also:
Trigger.CompletedExecutionInstruction
,triggered(Calendar)
-
updateAfterMisfire
void updateAfterMisfire(Calendar cal)
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 theTrigger
was created.
-
updateWithNewCalendar
void updateWithNewCalendar(Calendar cal, long misfireThreshold)
This method should not be used by the Quartz client.
To be implemented by the concrete class.
The implementation should update the
Trigger
's state based on the given new version of the associatedCalendar
(the state should be updated so that it's next fire time is appropriate given the Calendar's new settings).- Parameters:
cal
-
-
validate
void validate() throws SchedulerException
Validates whether the properties of the
JobDetail
are valid for submission into aScheduler
.- Throws:
java.lang.IllegalStateException
- if a required property (such as Name, Group, Class) is not set.SchedulerException
-
setFireInstanceId
void setFireInstanceId(java.lang.String id)
This method should not be used by the Quartz client.
Usable by
implementations, in order to facilitate 'recognizing' instances of firedJobStore
Trigger
s as their jobs complete execution.
-
getFireInstanceId
java.lang.String getFireInstanceId()
This method should not be used by the Quartz client.
-
setNextFireTime
void setNextFireTime(java.util.Date nextFireTime)
-
setPreviousFireTime
void setPreviousFireTime(java.util.Date previousFireTime)
-
-