Interface JobDetail
-
- All Superinterfaces:
java.lang.Cloneable
,java.io.Serializable
- All Known Implementing Classes:
JobDetailImpl
public interface JobDetail extends java.io.Serializable, java.lang.Cloneable
Conveys the detail properties of a givenJob
instance. JobDetails are to be created/defined withJobBuilder
.Quartz does not store an actual instance of a
Job
class, but instead allows you to define an instance of one, through the use of aJobDetail
.Job
s have a name and group associated with them, which should uniquely identify them within a single
.Scheduler
Trigger
s are the 'mechanism' by whichJob
s are scheduled. ManyTrigger
s can point to the sameJob
, but a singleTrigger
can only point to oneJob
.- Author:
- James House
- See Also:
JobBuilder
,Job
,JobDataMap
,Trigger
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Object
clone()
java.lang.String
getDescription()
Return the description given to theJob
instance by its creator (if any).JobBuilder
getJobBuilder()
Get aJobBuilder
that is configured to produce aJobDetail
identical to this one.java.lang.Class<? extends Job>
getJobClass()
Get the instance ofJob
that will be executed.JobDataMap
getJobDataMap()
Get theJobDataMap
that is associated with theJob
.JobKey
getKey()
boolean
isConcurrentExectionDisallowed()
boolean
isDurable()
Whether or not theJob
should remain stored after it is orphaned (no
point to it).Trigger
sboolean
isPersistJobDataAfterExecution()
boolean
requestsRecovery()
Instructs theScheduler
whether or not theJob
should be re-executed if a 'recovery' or 'fail-over' situation is encountered.
-
-
-
Method Detail
-
getKey
JobKey getKey()
-
getDescription
java.lang.String getDescription()
Return the description given to the
Job
instance by its creator (if any).- Returns:
- null if no description was set.
-
getJobClass
java.lang.Class<? extends Job> getJobClass()
Get the instance of
Job
that will be executed.
-
getJobDataMap
JobDataMap getJobDataMap()
Get the
JobDataMap
that is associated with theJob
.
-
isDurable
boolean isDurable()
Whether or not the
Job
should remain stored after it is orphaned (no
point to it).Trigger
sIf not explicitly set, the default value is
false
.- Returns:
true
if the Job should remain persisted after being orphaned.
-
isPersistJobDataAfterExecution
boolean isPersistJobDataAfterExecution()
- Returns:
- whether the associated Job class carries the
PersistJobDataAfterExecution
annotation. - See Also:
PersistJobDataAfterExecution
-
isConcurrentExectionDisallowed
boolean isConcurrentExectionDisallowed()
- Returns:
- whether the associated Job class carries the
DisallowConcurrentExecution
annotation. - See Also:
DisallowConcurrentExecution
-
requestsRecovery
boolean requestsRecovery()
Instructs the
Scheduler
whether or not theJob
should be re-executed if a 'recovery' or 'fail-over' situation is encountered.If not explicitly set, the default value is
false
.- See Also:
JobExecutionContext.isRecovering()
-
clone
java.lang.Object clone()
-
getJobBuilder
JobBuilder getJobBuilder()
Get aJobBuilder
that is configured to produce aJobDetail
identical to this one.
-
-