Merge branch 'alpha/JAL-3066_Jalview_212_slivka-integration' into alpha/JAL-3362_Jalv...

[jalview.git] / src / jalview / ws / api / JalviewWebServiceI.java

diff --git a/src/jalview/ws/api/JalviewWebServiceI.java b/src/jalview/ws/api/JalviewWebServiceI.java
index ecc8bab..6dda359 100644 (file)
--- a/src/jalview/ws/api/JalviewWebServiceI.java
+++ b/src/jalview/ws/api/JalviewWebServiceI.java
@@ -8,6 +8,14 @@ public interface JalviewWebServiceI
 
   void updateStatus(WsJob job);
 
+  /**
+   * Retrieve any additional log information for the job and update WsJob's
+   * progress. Results won't be retrieved until progress updates have finished.
+   * 
+   * @param job
+   * @return true if Job's stdout/progress panel was added to
+   * @throws Exception
+   */
   boolean updateJobProgress(WsJob job) throws Exception;
 
   boolean handleSubmitError(Throwable _lex, WsJob j, WebserviceInfo wsInfo)