de.businesslogics.ebics.schema.types
Class ReturnCode

java.lang.Object
  extended by de.businesslogics.ebics.schema.EbicsElement
      extended by de.businesslogics.ebics.schema.SimpleStringElement
          extended by de.businesslogics.ebics.schema.types.ReturnCode
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AuthenticatedReturnCode

public class ReturnCode
extends SimpleStringElement

The return codes are described in appendix 1 of the EBICS specification.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class de.businesslogics.ebics.schema.SimpleStringElement
SimpleStringElement.Parser, SimpleStringElement.StringParser
 
Field Summary
static ReturnCode EBICS_AUTHENTICATION_FAILED
           
static ReturnCode EBICS_BANK_PUBKEY_UPDATE_REQUIRED
           
static ReturnCode EBICS_DISTRIBUTED_SIGNATURE_AUTHORISATION_FAILED
           
static ReturnCode EBICS_DOWNLOAD_POSTPROCESS_DONE
           
static ReturnCode EBICS_DOWNLOAD_POSTPROCESS_SKIPPED
           
static ReturnCode EBICS_INCOMPATIBLE_ORDER_ATTRIBUTE
           
static ReturnCode EBICS_INTERNAL_ERROR
           
static ReturnCode EBICS_INVALID_ORDER_PARAMS
           
static ReturnCode EBICS_INVALID_ORDER_TYPE
           
static ReturnCode EBICS_INVALID_REQUEST
           
static ReturnCode EBICS_INVALID_REQUEST_CONTENT
           
static ReturnCode EBICS_INVALID_USER_OR_USER_STATE
           
static ReturnCode EBICS_INVALID_USER_STATE
           
static ReturnCode EBICS_INVALID_XML
           
static ReturnCode EBICS_MAX_ORDER_DATA_SIZE_EXCEEDED
           
static ReturnCode EBICS_MAX_SEGMENTS_EXCEEDED
           
static ReturnCode EBICS_MAX_TRANSACTIONS_EXCEEDED
           
static ReturnCode EBICS_OK
           
static ReturnCode EBICS_ORDER_PARAMS_IGNORED
           
static ReturnCode EBICS_PARTNER_ID_MISMATCH
           
static ReturnCode EBICS_SEGMENT_SIZE_EXCEEDED
           
static ReturnCode EBICS_TX_ABORT
           
static ReturnCode EBICS_TX_MESSAGE_REPLAY
           
static ReturnCode EBICS_TX_RECOVERY_SYNC
           
static ReturnCode EBICS_TX_SEGMENT_NUMBER_EXCEEDED
           
static ReturnCode EBICS_TX_SEGMENT_NUMBER_UNDERRUN
           
static ReturnCode EBICS_TX_UNKNOWN_TXID
           
static ReturnCode EBICS_UNKNOWN_HOSTID
           
static ReturnCode EBICS_UNSUPPORTED_ORDER_TYPE
           
static ReturnCode EBICS_USER_UNKNOWN
           
 
Constructor Summary
ReturnCode()
          For incoming messages
 
Method Summary
 boolean equals(Object obj)
          Compares regarding value.
static Collection<ReturnCode> getInstances()
           
 String getSymbolicName()
          Returns a slightly more human readable version of this return code.
 String getText()
          returns a display text for the default locale.
 String getText(Locale l)
          returns a description text for the given locale.
 int hashCode()
          Returns the value's hashcode.
 void throwException(ReportText text)
           
 
Methods inherited from class de.businesslogics.ebics.schema.SimpleStringElement
createParser, getValue, getValue, printValue, toString
 
Methods inherited from class de.businesslogics.ebics.schema.EbicsElement
name, namespace, printOut
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

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_ORDER_PARAMS_IGNORED

public static final ReturnCode EBICS_ORDER_PARAMS_IGNORED

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_DISTRIBUTED_SIGNATURE_AUTHORISATION_FAILED

public static final ReturnCode EBICS_DISTRIBUTED_SIGNATURE_AUTHORISATION_FAILED

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_INVALID_XML

public static final ReturnCode EBICS_INVALID_XML

EBICS_UNKNOWN_HOSTID

public static final ReturnCode EBICS_UNKNOWN_HOSTID

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_INVALID_ORDER_PARAMS

public static final ReturnCode EBICS_INVALID_ORDER_PARAMS

EBICS_INVALID_REQUEST_CONTENT

public static final ReturnCode EBICS_INVALID_REQUEST_CONTENT

EBICS_MAX_ORDER_DATA_SIZE_EXCEEDED

public static final ReturnCode EBICS_MAX_ORDER_DATA_SIZE_EXCEEDED

EBICS_MAX_SEGMENTS_EXCEEDED

public static final ReturnCode EBICS_MAX_SEGMENTS_EXCEEDED

EBICS_MAX_TRANSACTIONS_EXCEEDED

public static final ReturnCode EBICS_MAX_TRANSACTIONS_EXCEEDED

EBICS_PARTNER_ID_MISMATCH

public static final ReturnCode EBICS_PARTNER_ID_MISMATCH

EBICS_INCOMPATIBLE_ORDER_ATTRIBUTE

public static final ReturnCode EBICS_INCOMPATIBLE_ORDER_ATTRIBUTE
Constructor Detail

ReturnCode

public ReturnCode()
For incoming messages

Method Detail

throwException

public void throwException(ReportText text)
                    throws EbicsException
Throws:
EbicsException

getSymbolicName

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


equals

public boolean equals(Object obj)
Compares regarding value.

Overrides:
equals in class SimpleStringElement

hashCode

public int hashCode()
Returns the value's hashcode.

Overrides:
hashCode in class SimpleStringElement

getText

public String getText()
returns a display text for the default locale.

Returns:
a text that can be displayed.

getText

public String getText(Locale l)
returns a description text for the given locale.

Parameters:
l - the desired locale.
Returns:
a text that can be displayed.

getInstances

public static Collection<ReturnCode> getInstances()


Copyright © 2009 Business-Logics GmbH. All Rights Reserved.