Enum ReceiptStatus

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

    public enum ReceiptStatus
    extends java.lang.Enum<ReceiptStatus>
    Enumeration defining available receipt status
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ERROR_SENDING_MESSAGE
      Indicating that an error occurred when sending the message.
      RECIEVED_OK
      Indicating that message have received the message OK, and receipt received.
      RECIEVED_WITH_BAD_SIGNATURE
      Indicating that message was received but resulted in an error due to bad signature
      RECIEVED_WITH_HEADER_ERROR
      Indicating that message was received but resulted in an error in the header on the receiving side.
      RECIEVED_WITH_PAYLOAD_ERROR
      Indicating that message was received but resulted in an error in the payload on the receiving side.
      SENT
      Indicating that message have be sent, but no receipt have yet been received.
      VERIFIED_OK
      Indicating that message have processed the message OK, and completed the transaction, this step is not required in some workflows..
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ReceiptStatus findById​(int id)
      Finds the corresponding status or null if no status was found.
      int getId()  
      static ReceiptStatus valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ReceiptStatus[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • SENT

        public static final ReceiptStatus SENT
        Indicating that message have be sent, but no receipt have yet been received.
      • RECIEVED_OK

        public static final ReceiptStatus RECIEVED_OK
        Indicating that message have received the message OK, and receipt received.
      • VERIFIED_OK

        public static final ReceiptStatus VERIFIED_OK
        Indicating that message have processed the message OK, and completed the transaction, this step is not required in some workflows..
      • RECIEVED_WITH_HEADER_ERROR

        public static final ReceiptStatus RECIEVED_WITH_HEADER_ERROR
        Indicating that message was received but resulted in an error in the header on the receiving side.
      • RECIEVED_WITH_PAYLOAD_ERROR

        public static final ReceiptStatus RECIEVED_WITH_PAYLOAD_ERROR
        Indicating that message was received but resulted in an error in the payload on the receiving side.
      • RECIEVED_WITH_BAD_SIGNATURE

        public static final ReceiptStatus RECIEVED_WITH_BAD_SIGNATURE
        Indicating that message was received but resulted in an error due to bad signature
      • ERROR_SENDING_MESSAGE

        public static final ReceiptStatus ERROR_SENDING_MESSAGE
        Indicating that an error occurred when sending the message.
    • Method Detail

      • values

        public static ReceiptStatus[] 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 (ReceiptStatus c : ReceiptStatus.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ReceiptStatus 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
      • getId

        public int getId()
        Returns:
        the integer representation of this receipt status.
      • findById

        public static ReceiptStatus findById​(int id)
        Finds the corresponding status or null if no status was found.