1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36 package javax.ejb;
37
38 import java.io.Serializable;
39
40 /**
41 *
42 * The TimerHandle interface is implemented by all EJB timer handles.
43 *
44 */
45 public interface TimerHandle extends Serializable {
46
47 /**
48 * Obtain a reference to the timer represented by this handle.
49 *
50 * @return a reference to the timer represented by this handle.
51 *
52 * @exception java.lang.IllegalStateException If this method is
53 * invoked while the instance is in a state that does not allow access
54 * to this method.
55 *
56 * @exception javax.ejb.NoSuchObjectLocalException If invoked on a
57 * handle whose associated timer has expired or has been cancelled.
58 *
59 * @exception javax.ejb.EJBException If this method could not complete due
60 * to a system-level failure.
61 */
62 public Timer getTimer() throws java.lang.IllegalStateException,
63 javax.ejb.NoSuchObjectLocalException, javax.ejb.EJBException;
64
65 }