1   /**
2    * Distribution License:
3    * JSword is free software; you can redistribute it and/or modify it under
4    * the terms of the GNU Lesser General Public License, version 2.1 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 Lesser General Public License for more details.
9    *
10   * The License is available on the internet at:
11   *       http://www.gnu.org/copyleft/lgpl.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: BookList.java 2050 2010-12-09 15:31:45Z dmsmith $
21   */
22  package org.crosswire.jsword.book;
23  
24  import java.util.List;
25  
26  /**
27   * There are several lists of Books, the most important being the installed
28   * Books, however there may be others like the available books or books from a
29   * specific driver. This interface provides a common method of accessing all of
30   * them.
31   * 
32   * @see gnu.lgpl.License for license details.<br>
33   *      The copyright to this program is held by it's authors.
34   * @see gnu.lgpl.License
35   * @author Joe Walker [joe at eireneh dot com]
36   */
37  public interface BookList {
38      /**
39       * Get a list of all the Books of all types.
40       */
41      List<Book> getBooks();
42  
43      /**
44       * Get a filtered list of all the Books.
45       * 
46       * @see BookFilters
47       */
48      List<Book> getBooks(BookFilter filter);
49  
50      /**
51       * Remove a BibleListener from our list of listeners
52       * 
53       * @param li
54       *            The old listener
55       */
56      void addBooksListener(BooksListener li);
57  
58      /**
59       * Add a BibleListener to our list of listeners
60       * 
61       * @param li
62       *            The new listener
63       */
64      void removeBooksListener(BooksListener li);
65  }
66