src/jalview/ws/WSClientI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
   3  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.ws;
  19
  20 public interface WSClientI
  21 {
  22   /**
  23    * basic interface supported by web service clients used by
  24    * jalview.gui.WebserviceInfo to discover GUI properties and pass events back
  25    * to the client.
  26    *
  27    */
  28   /**
  29    * TODO: change this to be a WS Job Panel GUI 'attribute'
  30    *
  31    * @return boolean true if a job cancel button should be shown
  32    */
  33   boolean isCancellable();
  34
  35   /**
  36    * TODO: change this to be a WS Job Panel GUI 'attribute'
  37    *
  38    * @return boolean true if results can be merged into the source of input data
  39    */
  40   boolean canMergeResults();
  41
  42   /**
  43    * instruct client to cancel the job. This is also used by the GUI to
  44    */
  45   void cancelJob();
  46 }