Package org.apache.ofbiz.service.job

Class AbstractJob

java.lang.Object

org.apache.ofbiz.service.job.AbstractJob

All Implemented Interfaces:

Serializable, Runnable, Job

Direct Known Subclasses:

GenericServiceJob, PurgeJob

public abstract class AbstractJob
extends Object
implements Job, Serializable

Abstract Job.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.ofbiz.service.job.Job

Job.State

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractJob(String jobId, String jobName)

Method Summary

Modifier and Type	Method	Description
Job.State	currentState()	Returns the current state of this job.
void	deQueue()	Transitions this job to the pre-queued (created) state.
abstract void	exec()	Executes this Job.
Job.State	getCurrentState()	Gets current state.
String	getJobId()	Returns the ID of this Job.
String	getJobName()	Returns the name of this Job.
long	getPriority()	Returns the priority of this job, higher the number the higher the priority
long	getRuntime()	Returns the job execution time in milliseconds.
Date	getStartTime()	Returns the time this job is scheduled to start.
void	queue()	Transitions this job to the queued state.
void	run()
void	setCurrentState(Job.State currentState)	Sets current state.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ofbiz.service.job.Job

isValid

Constructor Details

AbstractJob

protected AbstractJob(String jobId,
 String jobName)

Method Details

getCurrentState

public Job.State getCurrentState()

Gets current state.

Returns:

the current state

setCurrentState

public void setCurrentState(Job.State currentState)

Sets current state.

Parameters:

currentState - the current state

currentState

public Job.State currentState()

Description copied from interface: Job

Returns the current state of this job.

Specified by:

currentState in interface Job

getJobId

public String getJobId()

Description copied from interface: Job

Returns the ID of this Job.

Specified by:

getJobId in interface Job

getJobName

public String getJobName()

Description copied from interface: Job

Returns the name of this Job.

Specified by:

getJobName in interface Job

queue

public void queue()
           throws InvalidJobException

Description copied from interface: Job

Transitions this job to the queued state.

Specified by:

queue in interface Job

Throws:

InvalidJobException

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

Throws:

InvalidJobException

exec

public abstract void exec()
                   throws InvalidJobException

Executes this Job. The run() method calls this method.

Throws:

InvalidJobException

run

public void run()

Specified by:

run in interface Runnable

getRuntime

public long getRuntime()

Description copied from interface: Job

Returns the job execution time in milliseconds. Returns zero if the job has not run.

Specified by:

getRuntime in interface Job

getStartTime

public Date getStartTime()

Description copied from interface: Job

Returns the time this job is scheduled to start.

Specified by:

getStartTime in interface Job

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