Package com.storedobject.job

Class Job

java.lang.Object

com.storedobject.job.Job

Direct Known Subclasses:

CheckDelivery, ComputeConsumption, DaemonJob

public abstract class Job
extends Object

A logic that extends this class is called a "Job". A Job can be scheduled to run (by invoking its execute() method) at some defined intervals in the background by creating entries in the Schedule data class. An instance is created only once and at defined time-intervals (based on the entries in the Schedule), the execute() method is invoked. See also DaemonJob.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
Job(Schedule schedule)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	alert(Object... messageParameters)	Send an alert to the configured persons.
void	clean()	This method is invoked when the Job is completed.
abstract void	execute()	Execute the Job.
Device	getDevice()	Get the device associated with this Job.
String	getStatus()	Get current status information if any.
TransactionManager	getTransactionManager()	Get the currently active TransactionManager.
void	log(Object any)	Log something to the device.
void	shutdown()	This method is invoked when the system is shutting down.

Methods inherited from class java.lang.Object

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

Constructor Details

Job

public Job(Schedule schedule)

Constructor.

Parameters:

schedule - Schedule defined for this Job.

Method Details

getTransactionManager

public TransactionManager getTransactionManager()

Get the currently active TransactionManager. Always, a valid TransactionManager exists during the life-cycle of the Job.

Returns:

The currently active TransactionManager.

getDevice

public Device getDevice()

Get the device associated with this Job. Sometimes, this will be useful if you want to generate a device-specific report.

Returns:

The current device.

execute

public abstract void execute()
                      throws Throwable

Execute the Job.

Throws:

Throwable - If an error is thrown from this method, execution is terminated and the details of the error will be logged.

clean

public void clean()

This method is invoked when the Job is completed. It can be used to clean up the resources. (In the case of DaemonJobs, it will be invoked only when any error occurs. (The default implementation does nothing).

shutdown

public void shutdown()

This method is invoked when the system is shutting down. It will be called even if the job is inactive at that time. (The default implementation does nothing).

log

public void log(Object any)

Log something to the device.

Parameters:

any - Log anything.

alert

public void alert(Object... messageParameters)

Send an alert to the configured persons. (When scheduling the Job, this can be configured).

Parameters:

messageParameters - Alert parameters.

getStatus

public String getStatus()

Get current status information if any.

Returns:

Current status information to display in the log.