1 | /**
|
---|
2 | *#########################################################################
|
---|
3 | *
|
---|
4 | * A component of the Gatherer application, part of the Greenstone digital
|
---|
5 | * library suite from the New Zealand Digital Library Project at the
|
---|
6 | * University of Waikato, New Zealand.
|
---|
7 | *
|
---|
8 | * <BR><BR>
|
---|
9 | *
|
---|
10 | * Author: John Thompson, Greenstone Digital Library, University of Waikato
|
---|
11 | *
|
---|
12 | * <BR><BR>
|
---|
13 | *
|
---|
14 | * Copyright (C) 1999 New Zealand Digital Library Project
|
---|
15 | *
|
---|
16 | * <BR><BR>
|
---|
17 | *
|
---|
18 | * This program is free software; you can redistribute it and/or modify
|
---|
19 | * it under the terms of the GNU General Public License as published by
|
---|
20 | * the Free Software Foundation; either version 2 of the License, or
|
---|
21 | * (at your option) any later version.
|
---|
22 | *
|
---|
23 | * <BR><BR>
|
---|
24 | *
|
---|
25 | * This program is distributed in the hope that it will be useful,
|
---|
26 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
27 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
28 | * GNU General Public License for more details.
|
---|
29 | *
|
---|
30 | * <BR><BR>
|
---|
31 | *
|
---|
32 | * You should have received a copy of the GNU General Public License
|
---|
33 | * along with this program; if not, write to the Free Software
|
---|
34 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
---|
35 | *########################################################################
|
---|
36 | */
|
---|
37 | package org.greenstone.gatherer.shell;
|
---|
38 |
|
---|
39 | /**
|
---|
40 | * Title: The Gatherer<br>
|
---|
41 | * Description: The Gatherer: a tool for gathering and enriching digital collections.<br>
|
---|
42 | * Copyright: Copyright (c) 2001<br>
|
---|
43 | * Company: The University of Waikato<br>
|
---|
44 | * Written: / /01<br>
|
---|
45 | * Revised: 12/05/02 - Commented<br>
|
---|
46 | * 29/05/02 - Moved into correct package<br>
|
---|
47 | * @author John Thompson, Greenstone Digital Libraries
|
---|
48 | * @version 2.1
|
---|
49 | */
|
---|
50 | import java.util.EventListener;
|
---|
51 |
|
---|
52 | /** This interface details the methods required of a class that wishes to listen to a <strong>GShell</strong>.
|
---|
53 | */
|
---|
54 | public interface GShellListener
|
---|
55 | extends EventListener {
|
---|
56 | /** All implementation of <i>GShellListener</i> must include this method so the listener can be informed of messages from the <strong>GShell</strong>.
|
---|
57 | * @param event A <strong>GShellEvent</strong> that contains, amoung other things, the message.
|
---|
58 | */
|
---|
59 | public void message(GShellEvent event);
|
---|
60 |
|
---|
61 | /** All implementation of <i>GShellListener</i> must include this method so the listener can be informed when a <strong>GShell</strong> begins its task.
|
---|
62 | * @param event A <strong>GShellEvent</strong> that contains details of the initial state of the <strong>GShell</strong> before task comencement.
|
---|
63 | */
|
---|
64 | public void processBegun(GShellEvent event);
|
---|
65 |
|
---|
66 | /** All implementation of <i>GShellListener</i> must include this method so the listener can be informed when a <strong>GShell</strong> completes its task.
|
---|
67 | * @param event A <strong>GShellEvent</strong> that contains details of the final state of the <strong>GShell</strong> after task completion.
|
---|
68 | */
|
---|
69 | public void processComplete(GShellEvent event);
|
---|
70 | }
|
---|