Module jakarta.ejb

Package jakarta.ejb

Interface TimerHandle

All Superinterfaces:

Serializable

public interface TimerHandle
extends Serializable

The TimerHandle interface allows the bean provider to obtain a serializable timer handle that may be persisted.

Since timers are local objects, a timer handle must not be passed through a bean's remote business interface, remote interface or web service interface.

Since:

EJB 2.1

Method Summary

Modifier and Type	Method	Description
Timer	getTimer()	Obtain a reference to the timer represented by this handle.

Method Details

getTimer

Timer getTimer()
        throws IllegalStateException,
NoSuchObjectLocalException,
EJBException

Obtain a reference to the timer represented by this handle.

Returns:

a reference to the timer represented by this handle.

Throws:

IllegalStateException - If this method is invoked while the instance is in a state that does not allow access to this method.

NoSuchObjectLocalException - If invoked on a handle whose associated timer has expired or has been cancelled.

EJBException - If this method could not complete due to a system-level failure.