merge
[jalview.git] / src / jalview / ws / WSClientI.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.ws;
22
23 public interface WSClientI
24 {
25   /**
26    * basic interface supported by web service clients used by
27    * jalview.gui.WebserviceInfo to discover GUI properties and pass events back
28    * to the client.
29    * 
30    */
31   /**
32    * TODO: change this to be a WS Job Panel GUI 'attribute'
33    * 
34    * @return boolean true if a job cancel button should be shown
35    */
36   boolean isCancellable();
37
38   /**
39    * TODO: change this to be a WS Job Panel GUI 'attribute'
40    * 
41    * @return boolean true if results can be merged into the source of input data
42    */
43   boolean canMergeResults();
44
45   /**
46    * instruct client to cancel the job. This is also used by the GUI to
47    */
48   void cancelJob();
49 }