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 org.jboss.test.timer.interfaces;
23:
24: /**
25: * @author Thomas Diesler
26: * @author Scott.Stark@jboss.org
27: * @version $Revision: 57211 $
28: */
29: public interface TimerEntity extends javax.ejb.EJBObject {
30: /**
31: * Start a single timer (if not already set) with the start date plus the period
32: * @param pPeriod Time that will elapse between now and the timed event in milliseconds
33: */
34: public void startSingleTimer(long pPeriod)
35: throws java.rmi.RemoteException;
36:
37: /**
38: * Start a timer (if not already set) with the start date plus the period and an interval of the given period
39: * @param pPeriod Time that will elapse between two events in milliseconds
40: */
41: public void startTimer(long pPeriod)
42: throws java.rmi.RemoteException;
43:
44: public void stopTimer() throws java.rmi.RemoteException;
45:
46: public int getTimeoutCount() throws java.rmi.RemoteException;
47:
48: public java.util.Date getNextTimeout()
49: throws java.rmi.RemoteException;
50:
51: public long getTimeRemaining() throws java.rmi.RemoteException;
52:
53: public java.lang.Object getInfo() throws java.rmi.RemoteException;
54:
55: public javax.ejb.TimerHandle getTimerHandle()
56: throws java.rmi.RemoteException;
57:
58: }
|