Package net.officefloor.frame.api.team

Interface Job

All Superinterfaces:

Runnable

public interface Job
extends Runnable

Job executed by a Team.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
void	cancel(Throwable cause)	Enables a Team to cancel the Job should it be overloaded with Job instances.
ProcessIdentifier	getProcessIdentifier()	Obtains the ProcessIdentifier for the ProcessState containing this Job.

Methods inherited from interface java.lang.Runnable

run

Method Details

getProcessIdentifier

ProcessIdentifier getProcessIdentifier()

Obtains the ProcessIdentifier 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. This is particular relevant for TeamOversight provided by the Executive.

An example use would be embedding OfficeFloor within an Application Server and using this ProcessIdentifier and a ThreadLocalAwareTeam to know the invoking Thread for interaction with ThreadLocal instances of the Application Server.

Returns:

Identifier for the ProcessState containing this Job

See Also:

• ThreadLocalAwareTeam

cancel

void cancel(Throwable cause)

Enables a Team to cancel the Job should it be overloaded with Job instances.

Parameters:

cause - Reason by Team for canceling the Job.