Package com.primavera.integration.client.bo.enm

Class JobStatus

java.lang.Object
com.primavera.integration.client.bo.enm.EnumType
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 Details

    • 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

    • DELEGATED

      public static final JobStatus DELEGATED

    • COMPLETED_WITH_ERRORS

      public static final JobStatus COMPLETED_WITH_ERRORS

  • Method Details

    • toString

      public 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 Object
      Returns:
      String a string representation of the object

    • getValue

      public String getValue()
      Gets the internal value of this JobStatus instance
      Specified by:
      getValue in class EnumType
      Returns:
      String the internal value

    • getDescription

      public String getDescription()
      Gets the description of this JobStatus instance
      Specified by:
      getDescription in class EnumType
      Returns:
      String the description

    • getJobStatus

      public static JobStatus getJobStatus(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 String[] getEnumValues()
      Gets an array of all internal values for this enumeration
      Returns:
      String[] an array of all internal values

    • getEnumDescriptions

      public static String[] getEnumDescriptions()
      Gets an array of all descriptions for this enumeration
      Returns:
      String[] an array of all descriptions