01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package javax.ejb;
23:
24: import java.io.Serializable;
25:
26: /**
27: * The TimerHandle interface is implemented by all EJB timer handles.
28: **/
29: public interface TimerHandle extends Serializable {
30:
31: /**
32: * Obtain a reference to the timer represented by this handle.
33: *
34: * @return Timer which this handle represents
35: *
36: * @throws IllegalStateException If this method is invoked while the instance is in
37: * a state that does not allow access to this method.
38: * @throws NoSuchObjectLocalException If invoked on a timer that has expired or has been cancelled.
39: * @throws EJBException If this method could not complete due to a system-level failure.
40: **/
41: public Timer getTimer() throws IllegalStateException,
42: NoSuchObjectLocalException, EJBException;
43: }
|