SearchModifier.java |
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 or later 5 * as published by the Free Software Foundation. This program is distributed 6 * in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even 7 * the 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 * © CrossWire Bible Society, 2005 - 2016 18 * 19 */ 20 package org.crosswire.jsword.index.search; 21 22 import java.io.Serializable; 23 24 /** 25 * A SearchModifier consists of the kinds of changes that can be done to a 26 * search. 27 * 28 * @see gnu.lgpl.License The GNU Lesser General Public License for details. 29 * @author DM Smith 30 */ 31 public interface SearchModifier extends Serializable { 32 /** 33 * @return true if the results of the search request should be ranked 34 */ 35 boolean isRanked(); 36 37 /** 38 * @return the maximum number of results, with Integer.MAX_VALUE meaning 39 * all. 40 */ 41 int getMaxResults(); 42 } 43