er.quartzscheduler.foundation

Class ERQSJob

java.lang.Object

er.quartzscheduler.foundation.ERQSAbstractJob

er.quartzscheduler.foundation.ERQSJob

All Implemented Interfaces:

org.quartz.InterruptableJob, org.quartz.Job

Direct Known Subclasses:

ERQSJob4Test, ERQSJobDemo

@DisallowConcurrentExecution
public abstract class ERQSJob
extends ERQSAbstractJob
implements org.quartz.InterruptableJob

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENTERPRISE_OBJECT_KEY
static String	NOT_PERSISTENT_OBJECT_KEY

Fields inherited from class er.quartzscheduler.foundation.ERQSAbstractJob

log

Constructor Summary

Constructors

Constructor and Description
ERQSJob()

Method Summary

Modifier and Type	Method and Description
protected abstract void	_execute() _execute() is called by execute().
void	execute(org.quartz.JobExecutionContext jobexecutioncontext) Implementation of Job interface.
ERQSJobDescription	getJobDescription()
ERQSJobDescription	getJobDescription(EOEditingContext ec) Send back the ERQSJobDescription Object attach to the job.
NSTimestamp	getLastExecutionDate()
void	interrupt() Called by the Scheduler when a user interrupts the Job.
protected boolean	isJobInterrupted()
abstract void	validateForDelete(ERQSJobDescription aJobDescription) It's a good place to put code that will check if the job description can be deleted or not.
abstract void	validateForSave(ERQSJobDescription aJobDescription) It's a good place to put code that will check if the job description can be saved or not.
abstract void	willDelete(ERQSJobDescription aJobDescription) It's a good place to put code that will be executed before job description deletion.
abstract void	willSave(ERQSJobDescription aJobDescription) It's a good place to put code that will be executed before job description save.

Methods inherited from class er.quartzscheduler.foundation.ERQSAbstractJob

editingContext, getJobContext, getScheduler, getSchedulerFPInstance, newEditingContext, setResultMessage

Methods inherited from class java.lang.Object

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

Field Detail

ENTERPRISE_OBJECT_KEY

public static final String ENTERPRISE_OBJECT_KEY

See Also:

Constant Field Values

NOT_PERSISTENT_OBJECT_KEY

public static final String NOT_PERSISTENT_OBJECT_KEY

See Also:

Constant Field Values

Constructor Detail

ERQSJob

public ERQSJob()

Method Detail

execute

public final void execute(org.quartz.JobExecutionContext jobexecutioncontext)
                   throws org.quartz.JobExecutionException

Implementation of Job interface. Called by the Scheduler when a Trigger associated with the job is fired.
getJobContext() returns the jobContext after execute() is called.

To be sure that any exception will be catched, _execute() call in surround by a try/catch block.

Specified by:

execute in interface org.quartz.Job

Overrides:

execute in class ERQSAbstractJob

Parameters:

jobexecutioncontext - passed by the scheduler

Throws:

org.quartz.JobExecutionException

See Also:

http://quartz-scheduler.org/documentation/best-practices

_execute

protected abstract void _execute()
                          throws org.quartz.JobExecutionException

_execute() is called by execute(). Put your code here and everything will be set up for you.

Throws:

org.quartz.JobExecutionException

willDelete

public abstract void willDelete(ERQSJobDescription aJobDescription)

It's a good place to put code that will be executed before job description deletion.

Nothing is done automatically, you have to call this method manually if you want to give a chance to the job to use its own logic.

Parameters:

aJobDescription -

willSave

public abstract void willSave(ERQSJobDescription aJobDescription)

It's a good place to put code that will be executed before job description save.

Nothing is done automatically, you have to call this method manually if you want to give a chance to the job to use its own logic.

Parameters:

aJobDescription -

validateForSave

public abstract void validateForSave(ERQSJobDescription aJobDescription)

It's a good place to put code that will check if the job description can be saved or not.

Nothing is done automatically, you have to call this method manually if you want to give a chance to the job to use its own logic.

Parameters:

aJobDescription -

validateForDelete

public abstract void validateForDelete(ERQSJobDescription aJobDescription)

It's a good place to put code that will check if the job description can be deleted or not.

Nothing is done automatically, you have to call this method manually if you want to give a chance to the job to use its own logic.

Parameters:

aJobDescription -

getJobDescription

public ERQSJobDescription getJobDescription(EOEditingContext ec)

Send back the ERQSJobDescription Object attach to the job.

Parameters:

ec - editingContext (can be null if the NOScheduler object has been already defaulted)

Returns:

the NOScheduler Object.

Throws:

IllegalStateException - if there is no EOGlobalID in the JobDataMap or if ec is null and ERQSJobDescription object isn't already defaulted

getJobDescription

public ERQSJobDescription getJobDescription()

getLastExecutionDate

public NSTimestamp getLastExecutionDate()

interrupt

public void interrupt()
               throws org.quartz.UnableToInterruptJobException

Called by the Scheduler when a user interrupts the Job. return void (nothing) if job interrupt is successful.

Specified by:

interrupt in interface org.quartz.InterruptableJob

Throws:

org.quartz.JobExecutionException - if there is an exception while interrupting the job.

org.quartz.UnableToInterruptJobException

isJobInterrupted

protected boolean isJobInterrupted()