com.helger.quartz.spi

Interface IMutableTrigger

All Superinterfaces:

Comparable<ITrigger>, ITrigger

All Known Subinterfaces:

IOperableTrigger

All Known Implementing Classes:

AbstractTrigger, CalendarIntervalTrigger, CronTrigger, DailyTimeIntervalTrigger, SimpleTrigger

public interface IMutableTrigger
extends ITrigger

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
IMutableTrigger	getClone()
void	setCalendarName(String sCalendarName) Associate the Calendar with the given name with this Trigger.
void	setDescription(String sDescription) Set a description for the Trigger instance - may be useful for remembering/displaying the purpose of the trigger, though the description has no meaning to Quartz.
void	setEndTime(Date endTime) Set the time at which the Trigger should quit repeating - regardless of any remaining repeats (based on the trigger's particular repeat settings).
void	setJobDataMap(JobDataMap jobDataMap) Set the JobDataMap to be associated with the Trigger.
void	setJobKey(JobKey key)
void	setKey(TriggerKey key)
void	setMisfireInstruction(ITrigger.EMisfireInstruction eMisfireInstruction) Set the instruction the Scheduler should be given for handling misfire situations for this Trigger- the concrete Trigger type that you are using will have defined a set of additional MISFIRE_INSTRUCTION_XXX constants that may be passed to this method.
void	setPriority(int priority) The priority of a Trigger acts as a tie breaker such that if two Triggers 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.
void	setStartTime(Date startTime) The time at which the trigger's scheduling should start.

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

setKey

void setKey(@Nonnull
            TriggerKey key)

setJobKey

void setJobKey(@Nonnull
               JobKey key)

setDescription

void setDescription(@Nullable
                    String sDescription)

Set a description for the Trigger instance - may be useful for remembering/displaying the purpose of the trigger, though the description has no meaning to Quartz.

setCalendarName

void setCalendarName(@Nullable
                     String sCalendarName)

Associate the Calendar with the given name with this Trigger.

Parameters:

sCalendarName - use null to dis-associate a Calendar.

setJobDataMap

void setJobDataMap(@Nullable
                   JobDataMap jobDataMap)

Set the JobDataMap to be associated with the Trigger.

Parameters:

jobDataMap - The new job data map. May be null.

setPriority

void setPriority(int priority)

The priority of a Trigger acts as a tie breaker such that if two Triggers 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.
If not explicitly set, the default value is 5.

See Also:

ITrigger.DEFAULT_PRIORITY

setStartTime

void setStartTime(@Nonnull
                  Date startTime)

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.

Parameters:

startTime - start time

setEndTime

void setEndTime(@Nullable
                Date endTime)

Set the time at which the Trigger should quit repeating - regardless of any remaining repeats (based on the trigger's particular repeat settings).

See Also:

TriggerUtils.computeEndTimeToAllowParticularNumberOfFirings(IOperableTrigger,com.helger.quartz.ICalendar,int)

setMisfireInstruction

void setMisfireInstruction(ITrigger.EMisfireInstruction eMisfireInstruction)

Set the instruction the Scheduler should be given for handling misfire situations for this Trigger- the concrete Trigger 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 MISFIRE_INSTRUCTION_SMART_POLICY.

See Also:

IOperableTrigger.updateAfterMisfire(com.helger.quartz.ICalendar), ISimpleTrigger, ICronTrigger

getClone

IMutableTrigger getClone()

Specified by:

getClone in interface ITrigger