src/jalview/ws/WSClientI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
   3  * Copyright (C) 2014 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 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  * The Jalview Authors are detailed in the 'AUTHORS' file.
  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 }