1 /* 2 * JBoss, Home of Professional Open Source 3 * Copyright 2005, JBoss Inc., and individual contributors as indicated 4 * by the @authors tag. See the copyright.txt in the distribution for a 5 * full listing of individual contributors. 6 * 7 * This is free software; you can redistribute it and/or modify it 8 * under the terms of the GNU Lesser General Public License as 9 * 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: 37406 $ 28 */ 29 public interface TimerEntity 30 extends javax.ejb.EJBObject 31 { 32 /** 33 * Start a single timer (if not already set) with the start date plus the period 34 * @param pPeriod Time that will elapse between now and the timed event in milliseconds 35 */ 36 public void startSingleTimer( long pPeriod ) 37 throws java.rmi.RemoteException; 38 39 /** 40 * Start a timer (if not already set) with the start date plus the period and an interval of the given period 41 * @param pPeriod Time that will elapse between two events in milliseconds 42 */ 43 public void startTimer( long pPeriod ) 44 throws java.rmi.RemoteException; 45 46 public void stopTimer( ) 47 throws java.rmi.RemoteException; 48 49 public int getTimeoutCount( ) 50 throws java.rmi.RemoteException; 51 52 public java.util.Date getNextTimeout( ) 53 throws java.rmi.RemoteException; 54 55 public long getTimeRemaining( ) 56 throws java.rmi.RemoteException; 57 58 public java.lang.Object getInfo( ) 59 throws java.rmi.RemoteException; 60 61 public javax.ejb.TimerHandle getTimerHandle( ) 62 throws java.rmi.RemoteException; 63 64 } 65