AAConWS further work

[jabaws.git] / webservices / compbio / data / msa / JManagement.java

diff --git a/webservices/compbio/data/msa/JManagement.java b/webservices/compbio/data/msa/JManagement.java
index b9b2f01..8232260 100644 (file)
--- a/webservices/compbio/data/msa/JManagement.java
+++ b/webservices/compbio/data/msa/JManagement.java
@@ -10,43 +10,44 @@ import compbio.metadata.JobStatus;
 public interface JManagement {\r
 \r
        /**\r
-        * Stop running job but leave its output untouched\r
+        * Stop running the job <code>jobId</code> but leave its output untouched\r
         * \r
         * @return true if job was cancelled successfully, false otherwise\r
         * @throws InvalidParameterException\r
-        *             thrown if jobId is empty or cannot be recognised e.g. in\r
+        *             is thrown if jobId is empty or cannot be recognised e.g. in\r
         *             invalid format\r
         */\r
        boolean cancelJob(@WebParam(name = "jobId") String jobId);\r
 \r
        /**\r
-        * Return the status of the job. @see JobStatus\r
+        * Return the status of the job.\r
         * \r
         * @param jobId\r
         *            - unique job identifier\r
         * @return JobStatus - status of the job\r
         * @throws InvalidParameterException\r
-        *             thrown if jobId is empty or cannot be recognised e.g. in\r
+        *             is thrown if jobId is empty or cannot be recognised e.g. in\r
         *             invalid format\r
+        * @see JobStatus\r
         */\r
        JobStatus getJobStatus(@WebParam(name = "jobId") String jobId);\r
 \r
        /**\r
         * Reads 1kb chunk from the statistics file which is specific to a given web\r
-        * service from the position. If in time of a request less then 1kb data is\r
-        * available from the position to the end of the file, then it returns all\r
-        * the data available from the position to the end of the file.\r
+        * service from the <code>position</code>. If in time of a request less then\r
+        * 1kb data is available from the position to the end of the file, then it\r
+        * returns all the data available from the position to the end of the file.\r
         * \r
         * @param jobId\r
         *            - unique job identifier\r
         * @param position\r
         *            - next position within the file to read\r
-        * @return ChunkHolder - @see ChunkHolder which contains a chuink of data\r
-        *         and a next position within the file from which no data has been\r
-        *         read\r
+        * @return ChunkHolder - which contains a chunk of data and a next position\r
+        *         within the file from which no data has been read\r
         * @throws InvalidParameterException\r
         *             thrown if jobId is empty or cannot be recognised e.g. in\r
         *             invalid format and also if the position value is negative\r
+        * @see ChunkHolder\r
         */\r
        ChunkHolder pullExecStatistics(@WebParam(name = "jobId") String jobId,\r
                        @WebParam(name = "position") long position);\r