Jalview 2.6 source licence

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

diff --git a/src/jalview/ws/WSClientI.java b/src/jalview/ws/WSClientI.java
index 2474078..f6d0de3 100755 (executable)
--- a/src/jalview/ws/WSClientI.java
+++ b/src/jalview/ws/WSClientI.java
@@ -1,7 +1,46 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
+ * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * 
+ * 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.
+ * 
+ * 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 Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ */
 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();
 }