PurgeJob (OFBiz R18.12 API)

java.lang.Object
- org.apache.ofbiz.service.job.AbstractJob
- - org.apache.ofbiz.service.job.PurgeJob

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, Job
```
public class PurgeJob
extends AbstractJob
implements java.io.Serializable
```
Purge job - removes a JobSandbox entity value and its related values.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.ofbiz.service.job.Job
  Job.State

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String module
- Fields inherited from class org.apache.ofbiz.service.job.AbstractJob
  currentState

Constructor Summary

Constructors
Constructor Description

PurgeJob(GenericValue jobValue)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`deQueue()`	Transitions this job to the pre-queued (created) state.
`void`	`exec()`	Executes this Job.
`boolean`	`isValid()`	Returns true if this job is ready to be queued.

Methods inherited from class org.apache.ofbiz.service.job.AbstractJob
currentState, getJobId, getJobName, getRuntime, getStartTime, queue, run

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

- Field Detail
  - module
```
public static final java.lang.String module
```
- Constructor Detail
  - PurgeJob
```
public PurgeJob(GenericValue jobValue)
```
- Method Detail
  - exec
```
public void exec()
          throws InvalidJobException
```
    Description copied from class: AbstractJob
    
    Executes this Job. The AbstractJob.run() method calls this method.
    
    Specified by:
    
    exec in class AbstractJob
    
    Throws:
    
    InvalidJobException
  - isValid
```
public boolean isValid()
```
    Description copied from interface: Job
    
    Returns true if this job is ready to be queued.
    
    Specified by:
    
    isValid in interface Job
  - deQueue
```
public void deQueue()
             throws InvalidJobException
```
    Description copied from interface: Job
    
    Transitions this job to the pre-queued (created) state. The job manager will call this method when there was a problem adding this job to the queue.
    
    Specified by:
    
    deQueue in interface Job
    
    Overrides:
    
    deQueue in class AbstractJob
    
    Throws:
    
    InvalidJobException