|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.integration.client.bo.enm.EnumType
com.primavera.integration.client.bo.enm.JobStatus
public class JobStatus
Job status enumerations are used with the job manager when getting the status of an asynchronous job. Valid values are 'Pending', 'Running', 'Complete', 'Failed', or 'Cancelled'.
To use an enumeration in a where clause, make sure you use the internal database value. This can be retrieved from a particular enum instance by calling getValue().
Field Summary | |
---|---|
static JobStatus |
CANCELLED
|
static JobStatus |
COMPLETE
|
static JobStatus |
FAILED
|
static JobStatus |
NULL
|
static JobStatus |
PENDING
|
static JobStatus |
RUNNING
|
Method Summary | |
---|---|
java.lang.String |
getDescription()
Gets the description of this JobStatus instance |
static java.lang.String[] |
getEnumDescriptions()
Gets an array of all descriptions for this enumeration |
static java.lang.String[] |
getEnumValues()
Gets an array of all internal values for this enumeration |
static JobStatus |
getJobStatus(int iJobStatus)
Gets an instance of JobStatus based on the integer value specified. |
static JobStatus |
getJobStatus(java.lang.String sJobStatus)
Gets an instance of JobStatus based on the String value specified. |
java.lang.String |
getValue()
Gets the internal value of this JobStatus instance |
java.lang.String |
toString()
Returns a string representation of the object, which is the same as the description returned by the getDescription() method |
Methods inherited from class com.primavera.integration.client.bo.enm.EnumType |
---|
equals, hashCode, intValue |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final JobStatus NULL
public static final JobStatus PENDING
public static final JobStatus RUNNING
public static final JobStatus COMPLETE
public static final JobStatus FAILED
public static final JobStatus CANCELLED
Method Detail |
---|
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getValue()
getValue
in class EnumType
public java.lang.String getDescription()
getDescription
in class EnumType
public static JobStatus getJobStatus(java.lang.String sJobStatus)
sJobStatus
- the internal value or description
public static JobStatus getJobStatus(int iJobStatus)
iJobStatus
- an integer representing a particular value of this class. This value is also used when exporting to XML.
public static java.lang.String[] getEnumValues()
public static java.lang.String[] getEnumDescriptions()
|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |