org.quartz
Interface JobDetail

All Superinterfaces:
java.lang.Cloneable, java.io.Serializable
All Known Subinterfaces:
LocalityJobDetail
All Known Implementing Classes:
DelegatingLocalityJobDetail, JobDetailImpl

public interface JobDetail
extends java.io.Serializable, java.lang.Cloneable

Conveys the detail properties of a given Job instance. JobDetails are to be created/defined with JobBuilder.

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 a JobDetail.

Jobs have a name and group associated with them, which should uniquely identify them within a single Scheduler.

Triggers are the 'mechanism' by which Jobs are scheduled. Many Triggers can point to the same Job, but a single Trigger can only point to one Job.

Author:
James House
See Also:
JobBuilder, Job, JobDataMap, Trigger

Method Summary
 java.lang.Object clone()
           
 java.lang.String getDescription()
           Return the description given to the Job instance by its creator (if any).
 JobBuilder getJobBuilder()
          Get a JobBuilder that is configured to produce a JobDetail identical to this one.
 java.lang.Class<? extends Job> getJobClass()
           Get the instance of Job that will be executed.
 JobDataMap getJobDataMap()
           Get the JobDataMap that is associated with the Job.
 JobKey getKey()
           
 boolean isConcurrentExectionDisallowed()
           
 boolean isDurable()
           Whether or not the Job should remain stored after it is orphaned (no Triggers point to it).
 boolean isPersistJobDataAfterExecution()
           
 boolean requestsRecovery()
           Instructs the Scheduler whether or not the Job 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 the Job.


isDurable

boolean isDurable()

Whether or not the Job should remain stored after it is orphaned (no Triggers point to it).

If 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 the Job 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 a JobBuilder that is configured to produce a JobDetail identical to this one.



Copyright 2001-2011, Terracotta, Inc.