| java.lang.Object
 org.ow2.easybeans.component.quartz.EasyBeansTimer
| EasyBeansTimer | | public class EasyBeansTimer implements Timer(Code) | | Implementation of the Timer interface of EJB specification.
author:
Florent Benoit |
| Constructor Summary | |
| public | EasyBeansTimer(EasyBeansJobDetail jobDetail, Trigger trigger, Scheduler scheduler)
Create a new Timer object with the given objects (job, trigger and scheduler). |
| Method Summary | |
| public void | cancel()
Cause the timer and all its associated expiration notifications to be
cancelled. | | 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. | | public Date | getNextTimeout()
Get the point in time at which the next timer expiration is scheduled to
occur. | | public long | getTimeRemaining()
Get the number of milliseconds that will elapse before the next scheduled
timer expiration. |
| EasyBeansTimer | | public EasyBeansTimer(EasyBeansJobDetail jobDetail, Trigger trigger, Scheduler scheduler)(Code) | | Create a new Timer object with the given objects (job, trigger and scheduler).
Parameters:
jobDetail - the given job used to cancel the timer or in order to get Serializable info
Parameters:
trigger - the trigger used to get the next fire
Parameters:
scheduler - for canceling jobs |
| 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 theinstance is in a state that does not allow access to this method.
throws:
NoSuchObjectLocalException - If invoked on a timer that has expiredor has been cancelled.
throws:
EJBException - If this method could not complete due to asystem-level failure. |
| 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 theinstance is in a state that does not allow access to this method.
throws:
NoSuchObjectLocalException - If invoked on a timer that has expiredor has been cancelled.
throws:
EJBException - If this method could not complete due to asystem-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, ornull if the info argument passed in at timer creation was null.
throws:
IllegalStateException - If this method is invoked while theinstance is in a state that does not allow access to this method.
throws:
NoSuchObjectLocalException - If invoked on a timer that has expiredor has been cancelled.
throws:
EJBException - If this method could not complete due to asystem-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 scheduledto occur.
throws:
IllegalStateException - If this method is invoked while theinstance is in a state that does not allow access to this method.
throws:
NoSuchObjectLocalException - If invoked on a timer that has expiredor has been cancelled.
throws:
EJBException - If this method could not complete due to asystem-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 nextscheduled timer expiration.
throws:
IllegalStateException - If this method is invoked while theinstance is in a state that does not allow access to this method.
throws:
NoSuchObjectLocalException - If invoked on a timer that has expiredor has been cancelled.
throws:
EJBException - If this method could not complete due to asystem-level failure. |
|
|