1   /**
2    * Distribution License:
3    * BibleDesktop is free software; you can redistribute it and/or modify it under
4    * the terms of the GNU General Public License, version 2 as published by
5    * the Free Software Foundation. This program is distributed in the hope
6    * that it will be useful, but WITHOUT ANY WARRANTY; without even the
7    * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
8    * See the GNU General Public License for more details.
9    *
10   * The License is available on the internet at:
11   *       http://www.gnu.org/copyleft/gpl.html
12   * or by writing to:
13   *      Free Software Foundation, Inc.
14   *      59 Temple Place - Suite 330
15   *      Boston, MA 02111-1307, USA
16   *
17   * Copyright: 2005
18   *     The copyright to this program is held by it's authors.
19   *
20   * ID: $Id: SiteEditor.java 1966 2009-10-30 01:15:14Z dmsmith $
21   */
22  package org.crosswire.bibledesktop.book.install;
23  
24  import org.crosswire.jsword.book.install.Installer;
25  
26  /**
27   * A SiteEditor allows for the editing of a site.
28   * 
29   * @see gnu.gpl.License for license details.<br>
30   *      The copyright to this program is held by it's authors.
31   * @author DM Smith [dmsmith555 at yahoo dot com]
32   */
33  public interface SiteEditor {
34      /**
35       * Establish the installer for this SiteEditor.
36       * 
37       * @param newInstaller
38       */
39      void setInstaller(Installer newInstaller);
40  
41      /**
42       * Get the installer associated with this SiteEditor
43       * 
44       * @return the installer
45       */
46      Installer getInstaller();
47  
48      /**
49       * Change the Editable state of this SiteEditor.
50       * 
51       * @param editable
52       */
53      void setEditable(boolean editable);
54  
55      /**
56       * Save the state of this SiteEditor.
57       */
58      void save();
59  
60      /**
61       * Set the state of this SiteEditor to the last save.
62       */
63      void reset();
64  }
65