Class ReturnCode

java.lang.Object
org.kopi.ebics.exception.ReturnCode
All Implemented Interfaces:
Serializable
public class ReturnCode extends Object implements Serializable
Representation of EBICS return codes. The return codes are described in chapter 13 of EBICS specification.
See Also:

  • Field Details

    • EBICS_OK

      public static final ReturnCode EBICS_OK

    • EBICS_DOWNLOAD_POSTPROCESS_DONE

      public static final ReturnCode EBICS_DOWNLOAD_POSTPROCESS_DONE

    • EBICS_DOWNLOAD_POSTPROCESS_SKIPPED

      public static final ReturnCode EBICS_DOWNLOAD_POSTPROCESS_SKIPPED

    • EBICS_TX_SEGMENT_NUMBER_UNDERRUN

      public static final ReturnCode EBICS_TX_SEGMENT_NUMBER_UNDERRUN

    • EBICS_AUTHENTICATION_FAILED

      public static final ReturnCode EBICS_AUTHENTICATION_FAILED

    • EBICS_INVALID_REQUEST

      public static final ReturnCode EBICS_INVALID_REQUEST

    • EBICS_INTERNAL_ERROR

      public static final ReturnCode EBICS_INTERNAL_ERROR

    • EBICS_TX_RECOVERY_SYNC

      public static final ReturnCode EBICS_TX_RECOVERY_SYNC

    • EBICS_INVALID_USER_OR_USER_STATE

      public static final ReturnCode EBICS_INVALID_USER_OR_USER_STATE

    • EBICS_USER_UNKNOWN

      public static final ReturnCode EBICS_USER_UNKNOWN

    • EBICS_INVALID_USER_STATE

      public static final ReturnCode EBICS_INVALID_USER_STATE

    • EBICS_INVALID_ORDER_TYPE

      public static final ReturnCode EBICS_INVALID_ORDER_TYPE

    • EBICS_UNSUPPORTED_ORDER_TYPE

      public static final ReturnCode EBICS_UNSUPPORTED_ORDER_TYPE

    • EBICS_USER_AUTHENTICATION_REQUIRED

      public static final ReturnCode EBICS_USER_AUTHENTICATION_REQUIRED

    • EBICS_BANK_PUBKEY_UPDATE_REQUIRED

      public static final ReturnCode EBICS_BANK_PUBKEY_UPDATE_REQUIRED

    • EBICS_SEGMENT_SIZE_EXCEEDED

      public static final ReturnCode EBICS_SEGMENT_SIZE_EXCEEDED

    • EBICS_TX_UNKNOWN_TXID

      public static final ReturnCode EBICS_TX_UNKNOWN_TXID

    • EBICS_TX_ABORT

      public static final ReturnCode EBICS_TX_ABORT

    • EBICS_TX_MESSAGE_REPLAY

      public static final ReturnCode EBICS_TX_MESSAGE_REPLAY

    • EBICS_TX_SEGMENT_NUMBER_EXCEEDED

      public static final ReturnCode EBICS_TX_SEGMENT_NUMBER_EXCEEDED

    • EBICS_X509_CERTIFICATE_NOT_VALID_YET

      public static final ReturnCode EBICS_X509_CERTIFICATE_NOT_VALID_YET

    • EBICS_MAX_TRANSACTIONS_EXCEEDED

      public static final ReturnCode EBICS_MAX_TRANSACTIONS_EXCEEDED

    • EBICS_SIGNATURE_VERIFICATION_FAILED

      public static final ReturnCode EBICS_SIGNATURE_VERIFICATION_FAILED

    • EBICS_INVALID_ORDER_DATA_FORMAT

      public static final ReturnCode EBICS_INVALID_ORDER_DATA_FORMAT

    • EBICS_NO_DOWNLOAD_DATA_AVAILABLE

      public static final ReturnCode EBICS_NO_DOWNLOAD_DATA_AVAILABLE

    • EBICS_ORDERID_ALREADY_EXISTS

      public static final ReturnCode EBICS_ORDERID_ALREADY_EXISTS

    • EBICS_AUTHORISATION_ORDER_TYPE_FAILED

      public static final ReturnCode EBICS_AUTHORISATION_ORDER_TYPE_FAILED

  • Constructor Details

    • ReturnCode

      public ReturnCode(String code, String symbolicName, String text)
      Constructs a new ReturnCode with a given standard code, symbolic name and text
      Parameters:
      code - the given standard code.
      symbolicName - the symbolic name.
      text - the code text

  • Method Details

    • throwException

      public void throwException() throws EbicsException
      Throws an equivalent EbicsException
      Throws:
      EbicsException

    • isOk

      public boolean isOk()
      Tells if the return code is an OK one.
      Returns:
      True if the return code is OK one.

    • getSymbolicName

      public String getSymbolicName()
      Returns a slightly more human readable version of this return code.
      Returns:
      a slightly more human readable version of this return code.

    • getText

      public String getText()
      Returns a display text for the default locale.
      Returns:
      a text that can be displayed.

    • getCode

      public int getCode()
      Returns the code.
      Returns:
      the code.

    • toReturnCode

      public static ReturnCode toReturnCode(String code, String text)
      Returns the equivalent ReturnCode of a given code
      Parameters:
      code - the given code
      text - the given code text
      Returns:
      the equivalent ReturnCode

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object