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 97eaa7f..92b7bb3 100755 (executable)
--- a/src/jalview/ws/WSClientI.java
+++ b/src/jalview/ws/WSClientI.java
@@ -1,6 +1,6 @@
 /*
  * Jalview - A Sequence Alignment Editor and Viewer
- * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Copyright (C) 2007 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
@@ -20,7 +20,25 @@ package jalview.ws;
 
 public interface WSClientI
 {
+  /**
+   * 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();
 }