File	Doc	Category	Size	Date	Package
WorkManager.java	API Doc	Glassfish v2 API	12644	Fri May 04 22:35:38 BST 2007	javax.resource.spi.work

WorkManager

Fields Summary
long	IMMEDIATE A constant to indicate timeout duration. A zero timeout value indicates an action be performed immediately.
long	INDEFINITE A constant to indicate timeout duration. A maximum timeout value indicates that an action be performed arbitrarily without any time constraint.
long	UNKNOWN A constant to indicate an unknown start delay duration or other unknown values.

Constructors Summary

Methods Summary
public void	doWork(Work work) Accepts a Work instance for processing. This call blocks until the Work instance completes execution. There is no guarantee on when the accepted Work instance would start execution ie., there is no time constraint to start execution. param work The unit of work to be done. Could be long or short-lived. throws WorkRejectedException indicates that a Work instance has been rejected from further processing. This can occur due to internal factors. throws WorkCompletedException indicates that a Work instance has completed execution with an exception.
public void	doWork(Work work, long startTimeout, ExecutionContext execContext, WorkListener workListener) Accepts a Work instance for processing. This call blocks until the Work instance completes execution. param work The unit of work to be done. Could be long or short-lived. param startTimeout a time duration (in milliseconds) within which the execution of the Work instance must start. Otherwise, the Work instance is rejected with a WorkRejectedException set to an appropriate error code (WorkRejectedException.TIMED_OUT). Note, this does not offer real-time guarantees. param execContext an object containing the execution context with which the submitted Work instance must be executed. param workListener an object which would be notified when the various Work processing events (work accepted, work rejected, work started, work completed) occur. throws WorkRejectedException indicates that a Work instance has been rejected from further processing. This can occur due to internal factors or start timeout expiration. throws WorkCompletedException indicates that a Work instance has completed execution with an exception.
public void	scheduleWork(Work work) Accepts a Work instance for processing. This call does not block and returns immediately once a Work instance has been accepted for processing. There is no guarantee on when the submitted Work instance would start execution ie., there is no time constraint to start execution. param work The unit of work to be done. Could be long or short-lived. throws WorkRejectedException indicates that a Work instance has been rejected from further processing. This can occur due to internal factors.
public void	scheduleWork(Work work, long startTimeout, ExecutionContext execContext, WorkListener workListener) Accepts a Work instance for processing. This call does not block and returns immediately once a Work instance has been accepted for processing. param work The unit of work to be done. Could be long or short-lived. param startTimeout a time duration (in milliseconds) within which the execution of the Work instance must start. Otherwise, the Work instance is rejected with a WorkRejectedException set to an appropriate error code (WorkRejectedException.TIMED_OUT). Note, this does not offer real-time guarantees. param execContext an object containing the execution context with which the submitted Work instance must be executed. param workListener an object which would be notified when the various Work processing events (work accepted, work rejected, work started, work completed) occur. throws WorkRejectedException indicates that a Work instance has been rejected from further processing. This can occur due to internal factors.
public long	startWork(Work work) Accepts a Work instance for processing. This call blocks until the Work instance starts execution but not until its completion. There is no guarantee on when the accepted Work instance would start execution ie., there is no time constraint to start execution. param work The unit of work to be done. Could be long or short-lived. return the time elapsed (in milliseconds) from Work acceptance until start of execution. Note, this does not offer real-time guarantees. It is valid to return -1, if the actual start delay duration is unknown. throws WorkRejectedException indicates that a Work instance has been rejected from further processing. This can occur due to internal factors.
public long	startWork(Work work, long startTimeout, ExecutionContext execContext, WorkListener workListener) Accepts a Work instance for processing. This call blocks until the Work instance starts execution but not until its completion. There is no guarantee on when the accepted Work instance would start execution ie., there is no time constraint to start execution. param work The unit of work to be done. Could be long or short-lived. param startTimeout a time duration (in milliseconds) within which the execution of the Work instance must start. Otherwise, the Work instance is rejected with a WorkRejectedException set to an appropriate error code (WorkRejectedException.TIMED_OUT). Note, this does not offer real-time guarantees. param execContext an object containing the execution context with which the submitted Work instance must be executed. param workListener an object which would be notified when the various Work processing events (work accepted, work rejected, work started, work completed) occur. return the time elapsed (in milliseconds) from Work acceptance until start of execution. Note, this does not offer real-time guarantees. It is valid to return -1, if the actual start delay duration is unknown. throws WorkRejectedException indicates that a Work instance has been rejected from further processing. This can occur due to internal factors or start timeout expiration.