added SeqSearch service interface. Documented and refactored web service client ...

[jalview.git] / src / jalview / ws / WSClientI.java

diff --git a/src/jalview/ws/WSClientI.java b/src/jalview/ws/WSClientI.java
index 7a2b212..92b7bb3 100755 (executable)
--- a/src/jalview/ws/WSClientI.java
+++ b/src/jalview/ws/WSClientI.java
@@ -21,20 +21,24 @@ package jalview.ws;
 public interface WSClientI
 {
   /**
-   * basic interface supported by web service clients 
+   * basic interface supported by web service clients used by
+   * jalview.gui.WebserviceInfo to discover GUI properties and
+   * pass events back to the client. 
+   * 
    */
   /**
-   *
-   * @return boolean true if job is cancellable
+   * 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
+   * instruct client to cancel the job. This is also used by the GUI to  
    */
   void cancelJob();
 }