javax.ejb
Interface Timer

All Known Implementing Classes:

TimerImpl (src)

public interface Timer

The Timer interface contains information about a timer that was created through the EJB Timer Service

cancel

public void cancel()
            throws java.lang.IllegalStateException,
                   NoSuchObjectLocalException (src) ,
                   EJBException (src) 

Cause the timer and all its associated expiration notifications to be cancelled.

Throws:

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

NoSuchObjectLocalException (src) - If invoked on a timer that has expired or has been cancelled.

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

getTimeRemaining

public long getTimeRemaining()
                      throws java.lang.IllegalStateException,
                             NoSuchObjectLocalException (src) ,
                             EJBException (src) 

Get the number of milliseconds that will elapse before the next scheduled timer expiration.

Returns:

Number of milliseconds that will elapse before the next scheduled timer expiration.

Throws:

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

NoSuchObjectLocalException (src) - If invoked on a timer that has expired or has been cancelled.

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

getNextTimeout

public java.util.Date getNextTimeout()
                              throws java.lang.IllegalStateException,
                                     NoSuchObjectLocalException (src) ,
                                     EJBException (src) 

Get the point in time at which the next timer expiration is scheduled to occur.

Returns:

Get the point in time at which the next timer expiration is scheduled to occur.

Throws:

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

NoSuchObjectLocalException (src) - If invoked on a timer that has expired or has been cancelled.

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

getInfo

public java.io.Serializable getInfo()
                             throws java.lang.IllegalStateException,
                                    NoSuchObjectLocalException (src) ,
                                    EJBException (src) 

Get the information associated with the timer at the time of creation.

Returns:

The Serializable object that was passed in at timer creation, or null if the info argument passed in at timer creation was null.

Throws:

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

NoSuchObjectLocalException (src) - If invoked on a timer that has expired or has been cancelled.

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

getHandle

public TimerHandle (src)  getHandle()
                      throws java.lang.IllegalStateException,
                             NoSuchObjectLocalException (src) ,
                             EJBException (src) 

Get a serializable handle to the timer. This handle can be used at a later time to re-obtain the timer reference.

Returns:

Handle of the Timer

Throws:

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

NoSuchObjectLocalException (src) - If invoked on a timer that has expired or has been cancelled.

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