/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2008, Red Hat Middleware LLC, and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.jboss.ejb.txtimer;

import java.io.Serializable;
import java.util.Date;

import javax.ejb.EJBException;
import javax.ejb.Timer;
import javax.ejb.TimerService;

/**
 * {@link TimerService} implementation which is able to restore a persisted timer
 *
 * @author Jaikiran Pai
 * @version $Revision: $
 */
public interface TimerRestoringTimerService extends PersistentIdTimerService
{
   /**
    * Restores a timer from the state provided through the passed parameters.
    * <p>
    *   This involves scheduling any appropriate task(s), for the appropriate next timeout.
    * </p>
    * 
    * @param initialExpiration The first expiry {@link Date} of the {@link Timer}, when it was created
    * @param intervalDuration The repeat interval (in milli. seconds) for the timeouts  
    * @param nextExpiry The next expiry {@link Date} of the timer. This need not be same as the <code>intialExpiration</code>.
    *                   The next expiry date of a periodic timer keeps changing whereas the intial (first) expiry date remains constant.
    * @param info The info to be passed to the timeout method
    * @param timerId The id of the timer being restored
    * @return Returns the restored timer
    * @throws IllegalArgumentException
    * @throws IllegalStateException
    * @throws EJBException
    */
   public Timer restoreTimer(Date initialExpiration, long intervalDuration, Date nextExpiry, Serializable info, String timerId)
   throws IllegalArgumentException, IllegalStateException, EJBException;

}