JobDetail (ph-mini-quartz 4.2.0 API)

java.lang.Object
- com.helger.quartz.impl.JobDetail

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<IJobDetail>, IJobDetail
```
public class JobDetail
extends Object
implements IJobDetail
```
Conveys the detail properties of a given Job instance.

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 IScheduler.

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, Sharada Jambula

See Also:

IJob, JobDataMap, ITrigger

Constructor Summary

Constructors
Constructor and Description
`JobDetail()` Create a `JobDetail` with no specified name or group, and the default settings of all the other properties.
`JobDetail(JobDetail aOther)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static JobDetail`	`create(String name, String group, Class<? extends IJob> jobClass)`
`boolean`	`equals(Object o)`
`JobDetail`	`getClone()`
`String`	`getDescription()` Return the description given to the `Job` instance by its creator (if any).
`String`	`getFullName()` Returns the 'full name' of the `JobDetail` in the format "group.name".
`String`	`getGroup()` Get the group of this `Job`.
`JobBuilder`	`getJobBuilder()` Get a `JobBuilder` that is configured to produce a `JobDetail` identical to this one.
`Class<? extends IJob>`	`getJobClass()` Get the instance of `Job` that will be executed.
`JobDataMap`	`getJobDataMap()` Get the `JobDataMap` that is associated with the `Job`.
`JobKey`	`getKey()`
`String`	`getName()` Get the name of this `Job`.
`int`	`hashCode()`
`boolean`	`isConcurrentExectionDisallowed()`
`boolean`	`isDurable()` Whether or not the `Job` should remain stored after it is orphaned (no `ITriggers` 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.
`void`	`setDescription(String description)` Set a description for the `Job` instance - may be useful for remembering/displaying the purpose of the job, though the description has no meaning to Quartz.
`void`	`setDurability(boolean durability)` Set whether or not the `Job` should remain stored after it is orphaned (no `Triggers` point to it).
`void`	`setGroup(String group)` Set the group of this `Job`.
`void`	`setJobClass(Class<? extends IJob> jobClass)` Set the instance of `Job` that will be executed.
`void`	`setJobDataMap(JobDataMap jobDataMap)` Set the `JobDataMap` to be associated with the `Job`.
`void`	`setKey(JobKey key)`
`void`	`setName(String name)` Set the name of this `Job`.
`void`	`setRequestsRecovery(boolean shouldRecover)` Set whether or not the the `Scheduler` should re-execute the `Job` if a 'recovery' or 'fail-over' situation is encountered.
`String`	`toString()` Return a simple string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - JobDetail
```
public JobDetail(@Nonnull
                 JobDetail aOther)
```
  - JobDetail
```
public JobDetail()
```
    Create a JobDetail with no specified name or group, and the default settings of all the other properties.
    Note that the setName(String),setGroup(String)and setJobClass(Class)methods must be called before the job can be placed into a IScheduler
- Method Detail
  - getName
```
public final String getName()
```
    Get the name of this Job.
  - setName
```
public final void setName(String name)
```
    Set the name of this Job.
    
    Throws:
    
    IllegalArgumentException - if name is null or empty.
  - getGroup
```
public final String getGroup()
```
    Get the group of this Job.
  - setGroup
```
public final void setGroup(String group)
```
    Set the group of this Job.
    
    Parameters:
    
    group - if null, Scheduler.DEFAULT_GROUP will be used.
    
    Throws:
    
    IllegalArgumentException - if the group is an empty string.
  - getFullName
```
@Nonnull
public final String getFullName()
```
    Returns the 'full name' of the JobDetail in the format "group.name".
  - getKey
```
@Nullable
public final JobKey getKey()
```
    Specified by:
    
    getKey in interface IJobDetail
  - setKey
```
public final void setKey(@Nonnull
                         JobKey key)
```
  - getDescription
```
public final String getDescription()
```
    Description copied from interface: IJobDetail
    
    Return the description given to the Job instance by its creator (if any).
    
    Specified by:
    
    getDescription in interface IJobDetail
    
    Returns:
    
    null if no description was set.
  - setDescription
```
public final void setDescription(String description)
```
    Set a description for the Job instance - may be useful for remembering/displaying the purpose of the job, though the description has no meaning to Quartz.
  - getJobClass
```
public final Class<? extends IJob> getJobClass()
```
    Description copied from interface: IJobDetail
    
    Get the instance of Job that will be executed.
    
    Specified by:
    
    getJobClass in interface IJobDetail
  - setJobClass
```
public final void setJobClass(Class<? extends IJob> jobClass)
```
    Set the instance of Job that will be executed.
    
    Throws:
    
    IllegalArgumentException - if jobClass is null or the class is not a Job.
  - getJobDataMap
```
@Nonnull
public JobDataMap getJobDataMap()
```
    Description copied from interface: IJobDetail
    
    Get the JobDataMap that is associated with the Job.
    
    Specified by:
    
    getJobDataMap in interface IJobDetail
  - setJobDataMap
```
public void setJobDataMap(@Nullable
                          JobDataMap jobDataMap)
```
    Set the JobDataMap to be associated with the Job.
    
    Parameters:
    
    jobDataMap - May be null.
  - setDurability
```
public void setDurability(boolean durability)
```
    Set 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.
  - setRequestsRecovery
```
public void setRequestsRecovery(boolean shouldRecover)
```
    Set whether or not the the Scheduler should re-execute the Job if a 'recovery' or 'fail-over' situation is encountered.
    If not explicitly set, the default value is false.
    
    See Also:
    
    IJobExecutionContext.isRecovering()
  - isDurable
```
public boolean isDurable()
```
    Description copied from interface: IJobDetail
    
    Whether or not the Job should remain stored after it is orphaned (no ITriggers point to it).
    If not explicitly set, the default value is false.
    
    Specified by:
    
    isDurable in interface IJobDetail
    
    Returns:
    
    true if the Job should remain persisted after being orphaned.
  - isPersistJobDataAfterExecution
```
public boolean isPersistJobDataAfterExecution()
```
    Specified by:
    
    isPersistJobDataAfterExecution in interface IJobDetail
    
    Returns:
    
    whether the associated Job class carries the PersistJobDataAfterExecution annotation.
    
    See Also:
    
    PersistJobDataAfterExecution
  - isConcurrentExectionDisallowed
```
public boolean isConcurrentExectionDisallowed()
```
    Specified by:
    
    isConcurrentExectionDisallowed in interface IJobDetail
    
    Returns:
    
    whether the associated Job class carries the DisallowConcurrentExecution annotation.
    
    See Also:
    
    DisallowConcurrentExecution
  - requestsRecovery
```
public boolean requestsRecovery()
```
    Description copied from interface: IJobDetail
    
    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.
    
    Specified by:
    
    requestsRecovery in interface IJobDetail
    
    See Also:
    
    IJobExecutionContext.isRecovering()
  - toString
```
public String toString()
```
    Return a simple string representation of this object.
    
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getJobBuilder
```
@Nonnull
public JobBuilder getJobBuilder()
```
    Description copied from interface: IJobDetail
    
    Get a JobBuilder that is configured to produce a JobDetail identical to this one.
    
    Specified by:
    
    getJobBuilder in interface IJobDetail
  - getClone
```
@Nonnull
public JobDetail getClone()
```
    Specified by:
    
    getClone in interface com.helger.commons.lang.ICloneable<IJobDetail>
  - create
```
@Nonnull
public static JobDetail create(String name,
                                         String group,
                                         Class<? extends IJob> jobClass)
```

Class JobDetail

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobDetail

JobDetail

Method Detail

getName

setName

getGroup

setGroup

getFullName

getKey

setKey

getDescription

setDescription

getJobClass

setJobClass

getJobDataMap

setJobDataMap

setDurability

setRequestsRecovery

isDurable

isPersistJobDataAfterExecution

isConcurrentExectionDisallowed

requestsRecovery

toString

equals

hashCode

getJobBuilder

getClone

create