Source code: com/eireneh/bible/control/search/words/ParamWord.java
1
2 package com.eireneh.bible.control.search.words;
3
4 import com.eireneh.bible.passage.*;
5 import com.eireneh.bible.control.search.*;
6
7 /**
8 * A ParamWord extends SearchWord to provide more information
9 * to a CommandWord. This will either be in the form of a String
10 * or in the form of a Passage (from a search)
11 * ParamWords are used by CommandWords that alter the final
12 * Passage.
13 *
14 * <table border='1' cellPadding='3' cellSpacing='0' width="100%">
15 * <tr><td bgColor='white'class='TableRowColor'><font size='-7'>
16 * Distribution Licence:<br />
17 * Project B is free software; you can redistribute it
18 * and/or modify it under the terms of the GNU General Public License,
19 * version 2 as published by the Free Software Foundation.<br />
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 * General Public License for more details.<br />
24 * The License is available on the internet
25 * <a href='http://www.gnu.org/copyleft/gpl.html'>here</a>, by writing to
26 * <i>Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
27 * MA 02111-1307, USA</i>, Or locally at the Licence link below.<br />
28 * The copyright to this program is held by it's authors.
29 * </font></td></tr></table>
30 * @see <a href='http://www.eireneh.com/servlets/Web'>Project B Home</a>
31 * @see docs.Licence
32 * @author Joe Walker
33 */
34 public interface ParamWord extends SearchWord
35 {
36 /**
37 * Get a word for something else to word on.
38 * @param engine The controller that can provide access to the search
39 * string or a default Bible.
40 * @return The requested text
41 * @exception SearchException If this action is not appropriate
42 */
43 public String getWord(Engine engine) throws SearchException;
44
45 /**
46 * Get a Passage or throw-up if that is not appropriate
47 * for this Word.
48 * @param engine The controller that can provide access to the search
49 * string or a default Bible.
50 * @return A Passage relevant to this command
51 * @exception SearchException If this action is not appropriate
52 */
53 public Passage getPassage(Engine engine) throws SearchException;
54 }