com.highdeal.pnr.hci
Class TransactionClearingException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.highdeal.hci.OperationFailureException
              com.highdeal.pnr.hci.TransactionClearingException

All Implemented Interfaces:

OperationResult, XMLMarshallable, java.io.Serializable

public class TransactionClearingException
extends OperationFailureException

Exception thrown when the charge process cannot clear the transaction.

See Also:

Serialized Form

XML Schema Fragment

<xs:element name="transactionClearingFault">
   <xs:complexType>
    <xs:attribute name="error" type="TransactionClearingFaultErrorType"/>
    <xs:attribute name="message" type="xs:string"/>
   </xs:complexType>
  </xs:element>

 <xs:simpleType name="TransactionClearingFaultErrorType">
   <xs:restriction base="xs:string">
      <xs:enumeration value="databaseFailure"/>
      <xs:enumeration value="invalidTransactionSet"/>
      <xs:enumeration value="badConfiguration"/>
      <xs:enumeration value="invalidAccountCurrency"/>
      <xs:enumeration value="accountLocked"/>
      <xs:enumeration value="accountClosed"/>
      <xs:enumeration value="cannotCreateAccount"/>
      <xs:enumeration value="accountDoesntExist"/>
      <xs:enumeration value="cannotChargePrepaidAccount"/>
      <xs:enumeration value="invoicingForbidden"/>
      <xs:enumeration value="unableToReclear"/>
     <xs:enumeration value="cannotComputeTax"/>
      <xs:enumeration value="invalidReservationSessionID"/>
   </xs:restriction>
 </xs:simpleType>

Field Summary

static int	ACCOUNT_CLOSED Constant error when an account is closed.
static int	ACCOUNT_DOESNT_EXIST Constant error when an account does not exist
static int	ACCOUNT_LOCKED Constant error when an account is locked.
static int	BAD_CONFIGURATION Constant error for a bad configuration.
static int	CANNOT_CHARGE_PREPAID_ACCOUNT Constant error when clearing into a prepaid account is impossible.
static int	CANNOT_COMPUTE_TAX Unable to compute tax
static int	CANNOT_CREATE_ACCOUNT Constant error when an account cannot be created.
static int	DATABASE_FAILURE Constant error for a database failure.
static int	INVALID_ACCOUNT_CURRENCY Constant error for an invalid account currency.
static int	INVALID_RESERVATION_SESSION_ID Constant error when trying to confirm a reservation with a bad session ID.
static int	INVALID_TRANSACTION_SET Constant error when clearing an invalid transaction set.
static int	INVOICING_FORBIDDEN Constant error when reinvoicing is not allowed.
static int	UNABLE_TO_RECLEAR Constant error when reclearing is unable.

Constructor Summary

TransactionClearingException()
Constructs an empty exception.

TransactionClearingException(int error, java.lang.String message)
Constructs an exception with an error code and a message.

Method Summary

void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the objects, the child represents the marshallable object to be added into the content tree.
int	getError() Returns the reason why the clearing of a transaction set failed.
java.lang.String	getMessage() Returns the detailed message explaining why the clearing of a transaction set failed.
void	marshal(XMLOutputter output) Gives an XML representation of this object, and of its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the tag beeing processed.

Methods inherited from class com.highdeal.hci.OperationFailureException

getOperandReference

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DATABASE_FAILURE

public static final int DATABASE_FAILURE

Constant error for a database failure.

See Also:

Constant Field Values

INVALID_TRANSACTION_SET

public static final int INVALID_TRANSACTION_SET

Constant error when clearing an invalid transaction set.

See Also:

Constant Field Values

BAD_CONFIGURATION

public static final int BAD_CONFIGURATION

Constant error for a bad configuration.

See Also:

Constant Field Values

INVALID_ACCOUNT_CURRENCY

public static final int INVALID_ACCOUNT_CURRENCY

Constant error for an invalid account currency.

See Also:

Constant Field Values

ACCOUNT_LOCKED

public static final int ACCOUNT_LOCKED

Constant error when an account is locked.

See Also:

Constant Field Values

ACCOUNT_CLOSED

public static final int ACCOUNT_CLOSED

Constant error when an account is closed.

See Also:

Constant Field Values

CANNOT_CREATE_ACCOUNT

public static final int CANNOT_CREATE_ACCOUNT

Constant error when an account cannot be created.

See Also:

Constant Field Values

ACCOUNT_DOESNT_EXIST

public static final int ACCOUNT_DOESNT_EXIST

Constant error when an account does not exist

See Also:

Constant Field Values

CANNOT_CHARGE_PREPAID_ACCOUNT

public static final int CANNOT_CHARGE_PREPAID_ACCOUNT

Constant error when clearing into a prepaid account is impossible.

See Also:

Constant Field Values

INVOICING_FORBIDDEN

public static final int INVOICING_FORBIDDEN

Constant error when reinvoicing is not allowed.

See Also:

Constant Field Values

UNABLE_TO_RECLEAR

public static final int UNABLE_TO_RECLEAR

Constant error when reclearing is unable.

See Also:

Constant Field Values

CANNOT_COMPUTE_TAX

public static final int CANNOT_COMPUTE_TAX

Unable to compute tax

See Also:

Constant Field Values

INVALID_RESERVATION_SESSION_ID

public static final int INVALID_RESERVATION_SESSION_ID

Constant error when trying to confirm a reservation with a bad session ID.

See Also:

Constant Field Values

Constructor Detail

TransactionClearingException

public TransactionClearingException()

Constructs an empty exception.

TransactionClearingException

public TransactionClearingException(int error,
                                    java.lang.String message)

Constructs an exception with an error code and a message. The message contains a human readable text.

Parameters:

message - the message.

error - the error.

Method Detail

getError

public int getError()

Returns the reason why the clearing of a transaction set failed.

Returns:

the error code.

See Also:

DATABASE_FAILURE, INVALID_TRANSACTION_SET, BAD_CONFIGURATION, INVALID_ACCOUNT_CURRENCY, ACCOUNT_LOCKED, ACCOUNT_CLOSED, CANNOT_CREATE_ACCOUNT, ACCOUNT_DOESNT_EXIST, CANNOT_CHARGE_PREPAID_ACCOUNT, INVOICING_FORBIDDEN, UNABLE_TO_RECLEAR, CANNOT_COMPUTE_TAX, INVALID_RESERVATION_SESSION_ID

getMessage

public java.lang.String getMessage()

Returns the detailed message explaining why the clearing of a transaction set failed.

Overrides:

getMessage in class java.lang.Throwable

Returns:

the detailed message.

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the tag beeing processed.

Parameters:

atts - the XML attributes of the current tag.

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Parameters:

cData - the character data to be added.

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the objects, the child represents the marshallable object to be added into the content tree.

Parameters:

tagName - the name of tag for the child.

child - the child to be added.

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, and of its children.

Parameters:

output - the XML output to marshall the object into.