/**
 *
 * Copyright
 * 2009-2015 Jayway Products AB
 * 2016-2017 Föreningen Sambruk
 *
 * Licensed under AGPL, Version 3.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.gnu.org/licenses/agpl.txt
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package se.streamsource.streamflow.web.infrastructure.event;

import java.io.IOException;
import java.util.Date;

import org.qi4j.api.io.Output;

/**
 * Interface for performing management operations on the EventStore.
 */
public interface EventManagement
{
   /**
    * Remove all events from the EventStore.
    *
    * @throws IOException
    */
   void removeAll() throws Exception;

   /**
    * Remove all events up to and including the given date. This is used
    * to clean out old events that are no longer needed.
    *
    * @param date
    * @throws IOException
    */
   void removeTo( Date date ) throws IOException;

   /**
    * Output used to restore events from a backup
    *
    * @return
    */
   Output<String, IOException> restore();
}