Package org.apache.ofbiz.service.job

Class PurgeJob

java.lang.Object

org.apache.ofbiz.service.job.AbstractJob

org.apache.ofbiz.service.job.PurgeJob

All Implemented Interfaces:

Serializable, Runnable, Job

public class PurgeJob
extends AbstractJob
implements 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

Constructor Summary

Constructors

Constructor	Description
PurgeJob(GenericValue jobValue)

Method Summary

Modifier and Type	Method	Description
void	deQueue()	Transitions this job to the pre-queued (created) state.
void	exec()	Executes this Job.
long	getPriority()	Returns the priority of this job, higher the number the higher the priority
boolean	isValid()	Returns true if this job is ready to be queued.

Methods inherited from class org.apache.ofbiz.service.job.AbstractJob

currentState, getCurrentState, getJobId, getJobName, getRuntime, getStartTime, queue, run, setCurrentState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PurgeJob

public PurgeJob(GenericValue jobValue)

Method Details

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

getPriority

public long getPriority()

Description copied from interface: Job

Returns the priority of this job, higher the number the higher the priority

Specified by:

getPriority in interface Job

Overrides:

getPriority in class AbstractJob