JAL-1645 Version-Rel Version 2.9 Year-Rel 2015 Licensing glob

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

diff --git a/src/jalview/ws/WSClientI.java b/src/jalview/ws/WSClientI.java
index 431efe4..2b3539e 100755 (executable)
--- a/src/jalview/ws/WSClientI.java
+++ b/src/jalview/ws/WSClientI.java
@@ -1,34 +1,49 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer
- * Copyright (C) 2005 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
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
+ * Copyright (C) 2015 The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview 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 3
  * 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.
- *
+ *  
+ * Jalview 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
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 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();
 }