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: SearchModifier.java 1966 2009-10-30 01:15:14Z dmsmith $
21   */
22  package org.crosswire.jsword.index.search;
23  
24  import java.io.Serializable;
25  
26  /**
27   * A SearchModifier consists of the kinds of changes that can be done to a
28   * search.
29   * 
30   * @see gnu.lgpl.License for license details.<br>
31   *      The copyright to this program is held by it's authors.
32   * @author DM Smith [dmsmith555 at yahoo dot com]
33   */
34  public interface SearchModifier extends Serializable {
35      /**
36       * @return true if the results of the search request should be ranked
37       */
38      boolean isRanked();
39  
40      /**
41       * @return the maximum number of results, with Integer.MAX_VALUE meaning
42       *         all.
43       */
44      int getMaxResults();
45  }
46