KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > ejb > TimerHandle


1 /**
2  * EasyBeans
3  * Copyright (C) 2006 Bull S.A.S.
4  * Contact: easybeans@objectweb.org
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19  * USA
20  *
21  * --------------------------------------------------------------------------
22  * $Id: TimerHandle.java 1100 2006-08-16 13:05:31Z benoitf $
23  * --------------------------------------------------------------------------
24  */

25
26 package javax.ejb;
27
28 import java.io.Serializable JavaDoc;
29
30 /**
31  * The TimerHandle interface is implemented by all EJB timer handles.
32  * @see <a HREF="http://www.jcp.org/en/jsr/detail?id=220">EJB 3.0 specification</a>
33  * @author Florent Benoit
34  */

35 public interface TimerHandle extends Serializable JavaDoc {
36
37     /**
38      * Obtain a reference to the timer represented by this handle.
39      * @return a reference to the timer represented by this handle.
40      * @throws IllegalStateException If this method is invoked while the
41      * instance is in a state that does not allow access to this method.
42      * @throws NoSuchObjectLocalException If invoked on a handle whose
43      * associated timer has expired or has been cancelled.
44      * @throws EJBException If this method could not complete due to a
45      * system-level failure.
46      */

47     Timer JavaDoc getTimer() throws IllegalStateException JavaDoc, NoSuchObjectLocalException JavaDoc, EJBException JavaDoc;
48
49 }
50
Popular Tags