001: /**
002: * EasyBeans
003: * Copyright (C) 2006 Bull S.A.S.
004: * Contact: easybeans@objectweb.org
005: *
006: * This library is free software; you can redistribute it and/or
007: * modify it under the terms of the GNU Lesser General Public
008: * License as published by the Free Software Foundation; either
009: * version 2.1 of the License, or any later version.
010: *
011: * This library is distributed in the hope that it will be useful,
012: * but WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * Lesser General Public License for more details.
015: *
016: * You should have received a copy of the GNU Lesser General Public
017: * License along with this library; if not, write to the Free Software
018: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
019: * USA
020: *
021: * --------------------------------------------------------------------------
022: * $Id: Timer.java 1100 2006-08-16 13:05:31Z benoitf $
023: * --------------------------------------------------------------------------
024: */package javax.ejb;
025:
026: import java.io.Serializable;
027: import java.util.Date;
028:
029: /**
030: * The Timer interface contains information about a timer that was created
031: * through the EJB Timer Service.
032: * @see <a href="http://www.jcp.org/en/jsr/detail?id=220">EJB 3.0 specification</a>
033: * @author Florent Benoit
034: */
035: public interface Timer {
036:
037: /**
038: * Cause the timer and all its associated expiration notifications to be
039: * cancelled.
040: * @throws IllegalStateException If this method is invoked while the
041: * instance is in a state that does not allow access to this method.
042: * @throws NoSuchObjectLocalException If invoked on a timer that has expired
043: * or has been cancelled.
044: * @throws EJBException If this method could not complete due to a
045: * system-level failure.
046: */
047: void cancel() throws IllegalStateException,
048: NoSuchObjectLocalException, EJBException;
049:
050: /**
051: * Get the number of milliseconds that will elapse before the next scheduled
052: * timer expiration.
053: * @return the number of milliseconds that will elapse before the next
054: * scheduled timer expiration.
055: * @throws IllegalStateException If this method is invoked while the
056: * instance is in a state that does not allow access to this method.
057: * @throws NoSuchObjectLocalException If invoked on a timer that has expired
058: * or has been cancelled.
059: * @throws EJBException If this method could not complete due to a
060: * system-level failure.
061: */
062: long getTimeRemaining() throws IllegalStateException,
063: NoSuchObjectLocalException, EJBException;
064:
065: /**
066: * Get the point in time at which the next timer expiration is scheduled to
067: * occur.
068: * @return the point in time at which the next timer expiration is scheduled
069: * to occur.
070: * @throws IllegalStateException If this method is invoked while the
071: * instance is in a state that does not allow access to this method.
072: * @throws NoSuchObjectLocalException If invoked on a timer that has expired
073: * or has been cancelled.
074: * @throws EJBException If this method could not complete due to a
075: * system-level failure.
076: */
077: Date getNextTimeout() throws IllegalStateException,
078: NoSuchObjectLocalException, EJBException;
079:
080: /**
081: * Get the information associated with the timer at the time of creation.
082: * @return The Serializable object that was passed in at timer creation, or
083: * null if the info argument passed in at timer creation was null.
084: * @throws IllegalStateException If this method is invoked while the
085: * instance is in a state that does not allow access to this method.
086: * @throws NoSuchObjectLocalException If invoked on a timer that has expired
087: * or has been cancelled.
088: * @throws EJBException If this method could not complete due to a
089: * system-level failure.
090: */
091: Serializable getInfo() throws IllegalStateException,
092: NoSuchObjectLocalException, EJBException;
093:
094: /**
095: * Get a serializable handle to the timer. This handle can be used at a
096: * later time to re-obtain the timer reference.
097: * @return a serializable handle to the timer.
098: * @throws IllegalStateException If this method is invoked while the
099: * instance is in a state that does not allow access to this method.
100: * @throws NoSuchObjectLocalException If invoked on a timer that has expired
101: * or has been cancelled.
102: * @throws EJBException If this method could not complete due to a
103: * system-level failure.
104: */
105: TimerHandle getHandle() throws IllegalStateException,
106: NoSuchObjectLocalException, EJBException;
107:
108: }
|