org.quartz.jobs

Interface JobDetail

All Superinterfaces:

Cloneable, Serializable

All Known Implementing Classes:

JobDetailImpl

public interface JobDetail
extends Serializable, 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 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

Method Summary

Modifier and Type	Method and Description
Object	clone()
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.
Class<? extends Job>	getJobClass() Get the instance of Job that will be executed.
JobDataMap	getJobDataMap() Get the JobDataMap that is associated with the Job.
String	getName()
boolean	isConcurrencyAllowed() The default behavior is to veto any job is currently running concurrent.

Method Detail

getName

String getName()

getDescription

String getDescription()

Return the description given to the Job instance by its creator (if any).

Returns:

null if no description was set.

getJobClass

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.

isConcurrencyAllowed

boolean isConcurrencyAllowed()

The default behavior is to veto any job is currently running concurrent. However, concurrent jobs can be created by setting the 'Concurrency' to true

Returns:

clone

Object clone()

getJobBuilder

JobBuilder getJobBuilder()

Get a JobBuilder that is configured to produce a JobDetail identical to this one.