+JManagement +

X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=website%2Fdm_javadoc%2Fcompbio%2Fdata%2Fmsa%2FJManagement.html;fp=website%2Fdm_javadoc%2Fcompbio%2Fdata%2Fmsa%2FJManagement.html;h=73a4653b024368a88e8e37c34a75149e5f820d85;hb=da8c820a7fb2edecb190589f3dc9c362e57a2f24;hp=0000000000000000000000000000000000000000;hpb=0bbebf27d045b1345bc042bdf24ef2e6808df251;p=jabaws.git diff --git a/website/dm_javadoc/compbio/data/msa/JManagement.html b/website/dm_javadoc/compbio/data/msa/JManagement.html new file mode 100644 index 0000000..73a4653 --- /dev/null +++ b/website/dm_javadoc/compbio/data/msa/JManagement.html @@ -0,0 +1,272 @@ + + + + + + +JManagement + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

+ +

+ PREV CLASS + NEXT CLASS

+ FRAMES + NO FRAMES + + + + +

+ SUMMARY: NESTED | FIELD | CONSTR | METHOD

+DETAIL: FIELD | CONSTR | METHOD

+ + + +

+ +

+ +compbio.data.msa +
+Interface JManagement

All Known Subinterfaces:: MsaWS<T>, SequenceAnnotation<T>

public interface JManagement

+ + +

+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ boolean cancelJob(java.lang.String jobId) + +
+          Stop running the job jobId but leave its output untouched
+ JobStatus getJobStatus(java.lang.String jobId) + +
+          Return the status of the job.
+ ChunkHolder pullExecStatistics(java.lang.String jobId, + long position) + +
+          Reads 1kb chunk from the statistics file which is specific to a given web + service from the position.
+ +

+Method Summary
+ `boolean`	`cancelJob(java.lang.String jobId)` + + + Stop running the job `jobId` but leave its output untouched
+ `JobStatus`	`getJobStatus(java.lang.String jobId)` + + + Return the status of the job.
+ `ChunkHolder`	`pullExecStatistics(java.lang.String jobId, + long position)` + + + Reads 1kb chunk from the statistics file which is specific to a given web + service from the `position`.

+ + + + + + + + +
+Method Detail
+ +

+cancelJob

+boolean cancelJob(java.lang.String jobId)

Stop running the job jobId but leave its output untouched +

Returns:: true if job was cancelled successfully, false otherwise +
Throws: +: java.security.InvalidParameterException - is thrown if jobId is empty or cannot be recognised e.g. in + invalid format

+ +

+getJobStatus

+JobStatus getJobStatus(java.lang.String jobId)

Return the status of the job. +

Parameters:: jobId - - unique job identifier +
Returns:: JobStatus - status of the job +
Throws: +: java.security.InvalidParameterException - is thrown if jobId is empty or cannot be recognised e.g. in + invalid format
See Also:: JobStatus

+ +

+pullExecStatistics

+ChunkHolder pullExecStatistics(java.lang.String jobId,
+                               long position)

Reads 1kb chunk from the statistics file which is specific to a given web + service from the position. If in time of a request less then + 1kb data is available from the position to the end of the file, then it + returns all the data available from the position to the end of the file. +

Parameters:: jobId - - unique job identifier; position - - next position within the file to read +
Returns:: ChunkHolder - which contains a chunk of data and a next position + within the file from which no data has been read +
Throws: +: java.security.InvalidParameterException - thrown if jobId is empty or cannot be recognised e.g. in + invalid format and also if the position value is negative
See Also:: ChunkHolder

+ +