X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fws%2FWSClientI.java;h=8e78ba571d1f5ceeca6d3a3ef48eac38a82fee8b;hb=12e7f97678ce85b0238f987d5f4eaf18512a0b94;hp=452072e988e733b56f580b7a3ec460febe84fa68;hpb=174230b4233d9ce80f94527768d2cd2f76da11ab;p=jalview.git

diff --git a/src/jalview/ws/WSClientI.java b/src/jalview/ws/WSClientI.java
index 452072e..8e78ba5 100755
--- a/src/jalview/ws/WSClientI.java
+++ b/src/jalview/ws/WSClientI.java
@@ -1,17 +1,17 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer
- * Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
- *
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
+ * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * 
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
  * of the License, or (at your option) any later version.
- *
+ * 
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- *
+ * 
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
@@ -20,15 +20,28 @@ package jalview.ws;
 
 public interface WSClientI
 {
-    /**
-     *
-     * @return boolean true if job is cancellable
-     */
-    boolean isCancellable();
-    /**
-     *
-     * @return boolean true if results can be merged into the source of input data
-     */
+  /**
+   * basic interface supported by web service clients used by
+   * jalview.gui.WebserviceInfo to discover GUI properties and pass events back
+   * to the client.
+   * 
+   */
+  /**
+   * TODO: change this to be a WS Job Panel GUI 'attribute'
+   * 
+   * @return boolean true if a job cancel button should be shown
+   */
+  boolean isCancellable();
+
+  /**
+   * TODO: change this to be a WS Job Panel GUI 'attribute'
+   * 
+   * @return boolean true if results can be merged into the source of input data
+   */
   boolean canMergeResults();
+
+  /**
+   * instruct client to cancel the job. This is also used by the GUI to
+   */
   void cancelJob();
 }