X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fws%2Fapi%2FJalviewWebServiceI.java;h=6dda35949e31d530c21eec780f330902c66fd47d;hb=d9c741ff46d3370f152d67b5ca8a24d217b6827e;hp=ecc8bab0a24daaad96f8bed8680c693e64d42ffe;hpb=57b0dee0192a285d36bd698655e639978487a30a;p=jalview.git

diff --git a/src/jalview/ws/api/JalviewWebServiceI.java b/src/jalview/ws/api/JalviewWebServiceI.java
index ecc8bab..6dda359 100644
--- 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)