com.helger.quartz.spi

Interface IOperableTrigger

All Superinterfaces:

Comparable<ITrigger>, IMutableTrigger, ITrigger

All Known Implementing Classes:

AbstractTrigger, CalendarIntervalTrigger, CronTrigger, DailyTimeIntervalTrigger, SimpleTrigger

public interface IOperableTrigger
extends IMutableTrigger

Nested Class Summary

Nested classes/interfaces inherited from interface com.helger.quartz.ITrigger

ITrigger.ECompletedExecutionInstruction, ITrigger.EMisfireInstruction, ITrigger.ETriggerState

Field Summary

Fields inherited from interface com.helger.quartz.ITrigger

DEFAULT_PRIORITY

Method Summary

Modifier and Type	Method and Description
Date	computeFirstFireTime(ICalendar aCalendar) This method should not be used by the Quartz client.
ITrigger.ECompletedExecutionInstruction	executionComplete(IJobExecutionContext aContext, JobExecutionException result) This method should not be used by the Quartz client.
IOperableTrigger	getClone()
String	getFireInstanceId() This method should not be used by the Quartz client.
void	setFireInstanceId(String id) This method should not be used by the Quartz client.
void	setNextFireTime(Date nextFireTime)
void	setPreviousFireTime(Date previousFireTime)
void	triggered(ICalendar calendar) This method should not be used by the Quartz client.
void	updateAfterMisfire(ICalendar cal) This method should not be used by the Quartz client.
void	updateWithNewCalendar(ICalendar cal, long misfireThreshold) This method should not be used by the Quartz client.
void	validate() Validates whether the properties of the JobDetail are valid for submission into a Scheduler.

Methods inherited from interface com.helger.quartz.spi.IMutableTrigger

setCalendarName, setDescription, setEndTime, setJobDataMap, setJobKey, setKey, setMisfireInstruction, setPriority, setStartTime

Methods inherited from interface com.helger.quartz.ITrigger

compareTo, equals, getCalendarName, getDescription, getEndTime, getFinalFireTime, getFireTimeAfter, getJobDataMap, getJobKey, getKey, getMisfireInstruction, getNextFireTime, getPreviousFireTime, getPriority, getScheduleBuilder, getStartTime, getTriggerBuilder, mayFireAgain

Method Detail

triggered

void triggered(ICalendar calendar)

This method should not be used by the Quartz client.
Called when the IScheduler has decided to 'fire' the trigger (execute the associated Job), in order to give the Trigger a chance to update itself for its next triggering (if any).

See Also:

executionComplete(IJobExecutionContext, JobExecutionException)

computeFirstFireTime

Date computeFirstFireTime(ICalendar aCalendar)

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 the Trigger 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 value getNextFireTime() will return (until after the first firing of the Trigger).

executionComplete

@Nonnull
ITrigger.ECompletedExecutionInstruction executionComplete(IJobExecutionContext aContext,
                                                                    @Nullable
                                                                    JobExecutionException result)

This method should not be used by the Quartz client.
Called after the Scheduler has executed the IJobDetail associated with the Trigger in order to get the final instruction code from the trigger.

Parameters:

aContext - is the JobExecutionContext that was used by the Job'sexecute(xx) method.

result - is the JobExecutionException thrown by the Job, if any (may be null).

Returns:

one of the CompletedExecutionInstruction constants.

See Also:

triggered(ICalendar)

updateAfterMisfire

void updateAfterMisfire(ICalendar 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 the Trigger was created.

updateWithNewCalendar

void updateWithNewCalendar(ICalendar 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 associated Calendar (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 a Scheduler.

Throws:

IllegalStateException - if a required property (such as Name, Group, Class) is not set.

SchedulerException

setFireInstanceId

void setFireInstanceId(@Nullable
                       String id)

This method should not be used by the Quartz client.
Usable by IJobStore implementations, in order to facilitate 'recognizing' instances of fired Trigger s as their jobs complete execution.

getFireInstanceId

@Nullable
String getFireInstanceId()

This method should not be used by the Quartz client.

setNextFireTime

void setNextFireTime(Date nextFireTime)

setPreviousFireTime

void setPreviousFireTime(Date previousFireTime)

getClone

IOperableTrigger getClone()

Specified by:

getClone in interface IMutableTrigger

Specified by:

getClone in interface ITrigger