package votorola.a; // Copyright 2008, Michael Allan. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Votorola Software"), to deal in the Votorola Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Votorola Software, and to permit persons to whom the Votorola Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Votorola Software. THE VOTOROLA SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE VOTOROLA SOFTWARE OR THE USE OR OTHER DEALINGS IN THE VOTOROLA SOFTWARE.


/** The input store of an electoral service.  The input store contains
  * the raw data that defines the state of an electoral service.  It includes voter input,
  * such as votes; and administrative input, such as configuration files.
  * Its filebase is the service directory, typically located at:
  * <blockquote>
  *     <em>{@linkplain ElectoralSubserver#votorolaDirectory() votorola-directory}</em>/<em>{@linkplain ElectoralService#name() service-name}</em>
  *     </blockquote>
  */
public interface InputStore
{

   // - I n p u t - S t o r e ------------------------------------------------------------


    /** Path to the base directory of the snapshot output store,
      * for this electoral service.  The snapshot output store contains a series
      * of snapshots, copied from the service's input store.
      * It may also contain additional data, derived from the snapshot,
      * such as mounted counts or voter lists.
      * <p>
      *     Multiple services may share the same base directory.
      *     The output files for this particular service will be stored in a subdirectory
      *     named after the service:
      *     <em>snapshotOutputStoreFilebase</em>/<em>service-name</em>.
      *     </p>
      */
    public String snapshotOutputStoreFilebase();



    /** The relational store of voter input, for this service.
      * It is a table named "{@linkplain ElectoralService#name() service-name}",
      * stored in the service's voter-input database.
      */
    public VoterInputTable voterInputTable();



}