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

Class DocumentScanStatus

java.lang.Object
com.primavera.integration.client.bo.enm.EnumType
com.primavera.integration.client.bo.enm.DocumentScanStatus
public class DocumentScanStatus extends EnumType
Document scan status enumerations are used with the document scan service. 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

  • 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 DocumentScanStatus instance
      Specified by:
      getValue in class EnumType
      Returns:
      String the internal value

    • getDescription

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

    • getDocumentScanStatus

      public static DocumentScanStatus getDocumentScanStatus(String sDocumentScanStatus)
      Gets an instance of DocumentScanStatus based on the String value specified.
      Parameters:
      sDocumentScanStatus - the internal value or description
      Returns:
      DocumentScanStatus the unique DocumentScanStatus instance

    • getDocumentScanStatus

      public static DocumentScanStatus getDocumentScanStatus(int iDocumentScanStatus)
      Gets an instance of DocumentScanStatus based on the integer value specified.
      Parameters:
      iDocumentScanStatus - an integer representing a particular value of this class. This value is also used when exporting to XML.
      Returns:
      DocumentScanStatus the unique DocumentScanStatus 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