| java.lang.Object org.jboss.ejb3.timerservice.quartz.TimerImpl
TimerImpl | public class TimerImpl implements Timer(Code) | | A view on an actual (persistent) timer.
This object must never be serializable (EJB3 18.4.1)
author: Carlo de Wolf version: $Revision: 60233 $ |
Method Summary | |
public void | cancel() Cause the timer and all its associated expiration notifications to be cancelled.
throws: IllegalStateException - If this method is invoked while the instance is in a state that does not allow access to this method. | protected void | checkState() | public TimerHandle | getHandle() Get a serializable handle to the timer. | public Serializable | getInfo() Get the information associated with the timer at the time of creation.
The Serializable object that was passed in at timer creation, or null if the info argument passed in at timer creation was null. throws: IllegalStateException - If this method is invoked while the instance is in a state that does not allow access to this method. | public Date | getNextTimeout() Get the point in time at which the next timer expiration is scheduled to occur.
The point in time at which the next timer expiration is scheduled to occur. throws: IllegalStateException - If this method is invoked while the instance is in a state that does not allow access to this method. | public long | getTimeRemaining() Get the number of milliseconds that will elapse before the next scheduled timer expiration.
The number of milliseconds that will elapse before the next scheduled timer expiration. throws: IllegalStateException - If this method is invoked while the instance is in a state that does not allow access to this method. |
TimerImpl | protected TimerImpl(Scheduler scheduler, Trigger trigger, Serializable info)(Code) | | |
cancel | public void cancel() throws IllegalStateException, NoSuchObjectLocalException, EJBException(Code) | | Cause the timer and all its associated expiration notifications to be cancelled.
throws: IllegalStateException - If this method is invoked while the instance is in a state that does not allow access to this method. throws: NoSuchObjectLocalException - If invoked on a timer that has expired or has been cancelled. throws: EJBException - If this method could not complete due to a system-level failure. |
checkState | protected void checkState()(Code) | | |
getHandle | public TimerHandle getHandle() throws IllegalStateException, NoSuchObjectLocalException, EJBException(Code) | | Get a serializable handle to the timer. This handle can be used at a later time to re-obtain the timer reference.
A serializable handle to the timer. throws: IllegalStateException - If this method is invoked while the instance is in a state that does not allow access to this method. throws: NoSuchObjectLocalException - If invoked on a timer that has expired or has been cancelled. throws: EJBException - If this method could not complete due to a system-level failure. |
getInfo | public Serializable getInfo() throws IllegalStateException, NoSuchObjectLocalException, EJBException(Code) | | Get the information associated with the timer at the time of creation.
The Serializable object that was passed in at timer creation, or null if the info argument passed in at timer creation was null. throws: IllegalStateException - If this method is invoked while the instance is in a state that does not allow access to this method. throws: NoSuchObjectLocalException - If invoked on a timer that has expired or has been cancelled. throws: EJBException - If this method could not complete due to a system-level failure. |
getNextTimeout | public Date getNextTimeout() throws IllegalStateException, NoSuchObjectLocalException, EJBException(Code) | | Get the point in time at which the next timer expiration is scheduled to occur.
The point in time at which the next timer expiration is scheduled to occur. throws: IllegalStateException - If this method is invoked while the instance is in a state that does not allow access to this method. throws: NoSuchObjectLocalException - If invoked on a timer that has expired or has been cancelled. throws: EJBException - If this method could not complete due to a system-level failure. |
getTimeRemaining | public long getTimeRemaining() throws IllegalStateException, NoSuchObjectLocalException, EJBException(Code) | | Get the number of milliseconds that will elapse before the next scheduled timer expiration.
The number of milliseconds that will elapse before the next scheduled timer expiration. throws: IllegalStateException - If this method is invoked while the instance is in a state that does not allow access to this method. throws: NoSuchObjectLocalException - If invoked on a timer that has expired or has been cancelled. throws: EJBException - If this method could not complete due to a system-level failure. |
|
|