Primavera Integration API 7.0

com.primavera.integration.client.bo.enm
Class JobStatus

java.lang.Object
  extended by com.primavera.integration.client.bo.enm.EnumType
      extended by com.primavera.integration.client.bo.enm.JobStatus

public class JobStatus
extends EnumType

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

NULL

public static final JobStatus NULL

PENDING

public static final JobStatus PENDING

RUNNING

public static final JobStatus RUNNING

COMPLETE

public static final JobStatus COMPLETE

FAILED

public static final JobStatus FAILED

CANCELLED

public static final JobStatus CANCELLED
Method Detail

toString

public java.lang.String toString()
Returns a string representation of the object, which is the same as the description returned by the getDescription() method

Overrides:
toString in class java.lang.Object
Returns:
String a string representation of the object

getValue

public java.lang.String getValue()
Gets the internal value of this JobStatus instance

Specified by:
getValue in class EnumType
Returns:
String the internal value

getDescription

public java.lang.String getDescription()
Gets the description of this JobStatus instance

Specified by:
getDescription in class EnumType
Returns:
String the description

getJobStatus

public static JobStatus getJobStatus(java.lang.String sJobStatus)
Gets an instance of JobStatus based on the String value specified.

Parameters:
sJobStatus - the internal value or description
Returns:
JobStatus the unique JobStatus instance

getJobStatus

public static JobStatus getJobStatus(int iJobStatus)
Gets an instance of JobStatus based on the integer value specified.

Parameters:
iJobStatus - an integer representing a particular value of this class. This value is also used when exporting to XML.
Returns:
JobStatus the unique JobStatus instance

getEnumValues

public static java.lang.String[] getEnumValues()
Gets an array of all internal values for this enumeration

Returns:
String[] an array of all internal values

getEnumDescriptions

public static java.lang.String[] getEnumDescriptions()
Gets an array of all descriptions for this enumeration

Returns:
String[] an array of all descriptions

Primavera Integration API 7.0

Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.