|
EJB 3.1 API 1.0.1.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Timer
The Timer interface contains information about a timer that was created through the EJB Timer Service
Method Summary | |
---|---|
void |
cancel()
Cause the timer and all its associated expiration notifications to be canceled. |
TimerHandle |
getHandle()
Get a serializable handle to the timer. |
Serializable |
getInfo()
Get the information associated with the timer at the time of creation. |
Date |
getNextTimeout()
Get the point in time at which the next timer expiration is scheduled to occur. |
ScheduleExpression |
getSchedule()
Get the schedule expression corresponding to this timer. |
long |
getTimeRemaining()
Get the number of milliseconds that will elapse before the next scheduled timer expiration. |
boolean |
isCalendarTimer()
Query whether this timer is a calendar-based timer. |
boolean |
isPersistent()
Query whether this timer has persistent semantics. |
Method Detail |
---|
void cancel() throws IllegalStateException, NoSuchObjectLocalException, EJBException
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 timer that has expired or has been canceled.
EJBException
- If this method could not complete due to a system-level failure.long getTimeRemaining() throws IllegalStateException, NoMoreTimeoutsException, NoSuchObjectLocalException, EJBException
IllegalStateException
- If this method is invoked while the instance is in
a state that does not allow access to this method.
NoMoreTimeoutsException
- Indicates that the timer has no future timeouts.
NoSuchObjectLocalException
- If invoked on a timer that has expired or has been canceled.
EJBException
- If this method could not complete due to a system-level failure.Date getNextTimeout() throws IllegalStateException, NoMoreTimeoutsException, NoSuchObjectLocalException, EJBException
IllegalStateException
- If this method is invoked while the instance is in
a state that does not allow access to this method.
NoMoreTimeoutsException
- Indicates that the timer has no future timeouts.
NoSuchObjectLocalException
- If invoked on a timer that has expired or has been canceled.
EJBException
- If this method could not complete due to a system-level failure.Serializable getInfo() throws IllegalStateException, NoSuchObjectLocalException, EJBException
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 timer that has expired or has been canceled.
EJBException
- If this method could not complete due to a system-level failure.TimerHandle getHandle() throws IllegalStateException, NoSuchObjectLocalException, EJBException
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 timer that has expired or has been canceled.
EJBException
- If this method could not complete due to a system-level failure.ScheduleExpression getSchedule() throws IllegalStateException, NoSuchObjectLocalException, EJBException
IllegalStateException
- If this method is invoked while the instance
is in a state that does not allow access to this method. Also thrown if
invoked on a timer that was created with one of the non-ScheduleExpression
TimerService.createTimer APIs.
NoSuchObjectLocalException
- If invoked on a timer that has expired or
has been cancelled.
EJBException
- If this method could not complete due to a system-level
failure.boolean isCalendarTimer() throws IllegalStateException, NoSuchObjectLocalException, EJBException
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 timer that has expired
or has been cancelled.
EJBException
- If this method could not complete due to a system-level failure.boolean isPersistent() throws IllegalStateException, NoSuchObjectLocalException, EJBException
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 timer that has expired
or has been cancelled.
EJBException
- If this method could not complete due to a system-level failure.
|
EJB 3.1 API 1.0.1.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |