net.officefloor.frame.spi.team

Interface Job

All Known Implementing Classes:

AbstractJobContainer, DutyJob, GovernanceJob, TaskJob

public interface Job

Job executed by a Team.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
void	cancelJob(Exception cause) Triggers to cancel the Job.
boolean	doJob(JobContext executionContext) Executes the Job.
Job	getNextJob() Obtains the next Job.
Object	getProcessIdentifier() Obtains the identifier for the ProcessState containing this Job.
void	setNextJob(Job job) Specifies the next Job.

Method Detail

doJob

boolean doJob(JobContext executionContext)

Executes the Job.

The return indicates if the Job has been completed and may be released. Returning false indicates this method must be executed again (and possibly again and again) until it returns true.

Parameters:

executionContext - Context for execution.

Returns:

true if the Job has completed.

cancelJob

void cancelJob(Exception cause)

Triggers to cancel the Job.

Parameters:

cause - Cause providing reason for cancelling the Job.s

getProcessIdentifier

Object getProcessIdentifier()

Obtains the identifier for the ProcessState containing this Job.

This allows the Team executing the Job to be aware of the ProcessState context in which the Job is to be executed.

An example use would be embedding OfficeFloor within an Application Server and using this identifier and a ProcessContextListener to know the invoking Thread for interaction with JNDI.

Returns:

Identifier for the ProcessState containing this Job

See Also:

ProcessContextListener

setNextJob

void setNextJob(Job job)

Specifies the next Job. This provides ability to create a linked list of Job instances.

Note there is no thread-safety guaranteed on this method.

Parameters:

job - Job that is next in the list to this Job.

See Also:

getNextJob()

getNextJob

Job getNextJob()

Obtains the next Job. This provides ability to create a linked list of Job instances.

Note there is no thread-safety guaranteed on this method.

Returns:

Next Job after this in the list.

See Also:

setNextJob(Job)