src/jalview/ws/WSClientI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
   3  * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  18  */
  19 package jalview.ws;
  20
  21 public interface WSClientI
  22 {
  23   /**
  24    * basic interface supported by web service clients used by
  25    * jalview.gui.WebserviceInfo to discover GUI properties and pass events back
  26    * to the client.
  27    *
  28    */
  29   /**
  30    * TODO: change this to be a WS Job Panel GUI 'attribute'
  31    *
  32    * @return boolean true if a job cancel button should be shown
  33    */
  34   boolean isCancellable();
  35
  36   /**
  37    * TODO: change this to be a WS Job Panel GUI 'attribute'
  38    *
  39    * @return boolean true if results can be merged into the source of input data
  40    */
  41   boolean canMergeResults();
  42
  43   /**
  44    * instruct client to cancel the job. This is also used by the GUI to
  45    */
  46   void cancelJob();
  47 }