+JobStatus +

X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=website%2Fdm_javadoc%2Fcompbio%2Fmetadata%2FJobStatus.html;fp=website%2Fdm_javadoc%2Fcompbio%2Fmetadata%2FJobStatus.html;h=612053a82f85c0f3641562c6ab6bfff081bce2aa;hb=da8c820a7fb2edecb190589f3dc9c362e57a2f24;hp=0000000000000000000000000000000000000000;hpb=0bbebf27d045b1345bc042bdf24ef2e6808df251;p=jabaws.git diff --git a/website/dm_javadoc/compbio/metadata/JobStatus.html b/website/dm_javadoc/compbio/metadata/JobStatus.html new file mode 100644 index 0000000..612053a --- /dev/null +++ b/website/dm_javadoc/compbio/metadata/JobStatus.html @@ -0,0 +1,465 @@ + + + + + + +JobStatus + + + + + + + + + + + + +

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

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

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

+ +

+ PREV CLASS + NEXT CLASS

+ FRAMES + NO FRAMES + + + + +

+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

+DETAIL: ENUM CONSTANTS | FIELD | METHOD

+ + + +

+ +

+ +compbio.metadata +
+Enum JobStatus

+java.lang.Object
+  java.lang.Enum<JobStatus>
+      compbio.metadata.JobStatus
+

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<JobStatus>

public enum JobStatus
extends java.lang.Enum<JobStatus>
extends java.lang.Enum<JobStatus>

+ + +

+The status of the job. +

+ +

Version:: 1.0 October 2009
Author:: pvtroshin

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
CANCELLED + +
+          Jobs that has been cancelled
COLLECTED + +
+          Results has been collected
FAILED + +
+          Failed jobs
FINISHED + +
+          Finished jobs
PENDING + +
+          Jobs which are in the queue and awaiting execution reported for cluster + jobs only
RUNNING + +
+          Jobs that are running
STARTED + +
+          Job calculation has been started.
SUBMITTED + +
+          Job has been submitted.
UNDEFINED + +
+          Represents jobs with unknown status
+ + + + + + + + + + + + + + + + +
+Method Summary
+static JobStatus valueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static JobStatus[] values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + + +
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+ +

+Enum Constant Summary
`CANCELLED` + + + Jobs that has been cancelled
`COLLECTED` + + + Results has been collected
`FAILED` + + + Failed jobs
`FINISHED` + + + Finished jobs
`PENDING` + + + Jobs which are in the queue and awaiting execution reported for cluster + jobs only
`RUNNING` + + + Jobs that are running
`STARTED` + + + Job calculation has been started.
`SUBMITTED` + + + Job has been submitted.
`UNDEFINED` + + + Represents jobs with unknown status

+Method Summary
+`static JobStatus`	`valueOf(java.lang.String name)` + + + Returns the enum constant of this type with the specified name.
+`static JobStatus[]`	`values()` + + + Returns an array containing the constants of this enum type, in +the order they are declared.

Methods inherited from class java.lang.Enum
`compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

+ + + + + + + + +
+Enum Constant Detail
+ +

+PENDING

+public static final JobStatus PENDING

Jobs which are in the queue and awaiting execution reported for cluster + jobs only +

+ +

+RUNNING

+public static final JobStatus RUNNING

Jobs that are running +

+ +

+CANCELLED

+public static final JobStatus CANCELLED

Jobs that has been cancelled +

+ +

+FINISHED

+public static final JobStatus FINISHED

Finished jobs +

+ +

+FAILED

+public static final JobStatus FAILED

Failed jobs +

+ +

+UNDEFINED

+public static final JobStatus UNDEFINED

Represents jobs with unknown status +

+ +

+STARTED

+public static final JobStatus STARTED

Job calculation has been started. First status reported by the local + engine +

+ +

+SUBMITTED

+public static final JobStatus SUBMITTED

Job has been submitted. This status is only set for cluster jobs +

+ +

+COLLECTED

+public static final JobStatus COLLECTED

Results has been collected +

+ +

+ + + + + + + + +

+Method Detail

+ +

+values

+public static JobStatus[] values()

Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +

+for (JobStatus c : JobStatus.values())
+    System.out.println(c);
+

Returns:: an array containing the constants of this enum type, in +the order they are declared

+ +

+valueOf

+public static JobStatus valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

Parameters:: name - the name of the enum constant to be returned. +
Returns:: the enum constant with the specified name +
Throws: +: java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +; java.lang.NullPointerException - if the argument is null

+ +