com.highdeal.pnr.hci

Class PurgeAllowanceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.highdeal.hci.OperationFailureException

com.highdeal.pnr.hci.PurgeAllowanceException

All Implemented Interfaces:

OperationResult, XMLMarshallable, java.io.Serializable

public class PurgeAllowanceException
extends OperationFailureException

Exception thrown when the purge allowance operation is requested with invalid arguments.

Such service operation request may fail for several reasons:

• DISPATCHER_COMMUNICATION_FAILED
• INVALID_TO_DATE
• PURGE_ALLOWANCES_PROCESS_ALREADY_RUNNING
• UNKNOWN

Note

Refer to the Field Detail section for more information about a particular code and to determine the appropriate error handling in your client application.

See Also:

Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="purgeAllowanceFault">
   <xs:complexType>
     <xs:attribute name="reason" type="PurgeAllowanceFaultReasonType"/>
     <xs:attribute name="message" type="xs:string"/>
    </xs:complexType>
  </xs:element>

  <xs:simpleType name="PurgeAllowanceFaultReasonType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="invalidToDate"/>
      <xs:enumeration value="purgeProcessAlreadyRunning"/>
      <xs:enumeration value="dispatcherCommunicationFailed"/>
      <xs:enumeration value="unknown"/>
      </xs:restriction>
   </xs:simpleType>

Field Summary

Fields

Modifier and Type	Field and Description
static int	DISPATCHER_COMMUNICATION_FAILED 3: Constant for dispatcherCommunicationFailed error.
static int	INVALID_TO_DATE 1: Constant for invalidToDate error.
static java.lang.String	OPERATION_NAME The XML tag name of this exception: "purgeAllowanceFault"
static int	PURGE_ALLOWANCES_PROCESS_ALREADY_RUNNING 2: Constant for purgeAllowanceProcesssAlreadyRunning error.
static int	UNKNOWN -1: Constant for unknown error.

Constructor Summary

Constructors

Constructor and Description
PurgeAllowanceException() Constructs an empty exception.
PurgeAllowanceException(int reason, java.lang.String message) Constructs an exception with a message; It contains a human readable text.

Method Summary

Modifier and Type	Method and Description
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 object, the child representing the marshallable object which must be added to the element.
java.lang.String	getMessage() Gets the message for this PurgeAllowanceException.
int	getReason() Gets the reason of this PurgeAllowanceException.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.

Methods inherited from class com.highdeal.hci.OperationFailureException

getOperandReference

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

The XML tag name of this exception: "purgeAllowanceFault"

See Also:

Constant Field Values

INVALID_TO_DATE

public static final int INVALID_TO_DATE

1: Constant for invalidToDate error.

See Also:

Constant Field Values

PURGE_ALLOWANCES_PROCESS_ALREADY_RUNNING

public static final int PURGE_ALLOWANCES_PROCESS_ALREADY_RUNNING

2: Constant for purgeAllowanceProcesssAlreadyRunning error. An purge allowance process is still running.

See Also:

Constant Field Values

DISPATCHER_COMMUNICATION_FAILED

public static final int DISPATCHER_COMMUNICATION_FAILED

3: Constant for dispatcherCommunicationFailed error.

See Also:

Constant Field Values

UNKNOWN

public static final int UNKNOWN

-1: Constant for unknown error.

See Also:

Constant Field Values

Constructor Detail

PurgeAllowanceException

public PurgeAllowanceException()

Constructs an empty exception.

PurgeAllowanceException

public PurgeAllowanceException(int reason,
                               java.lang.String message)

Constructs an exception with a message; It contains a human readable text.

Parameters:

reason - The reason

message - The message

See Also:

INVALID_TO_DATE, PURGE_ALLOWANCES_PROCESS_ALREADY_RUNNING, DISPATCHER_COMMUNICATION_FAILED, UNKNOWN

Method Detail

getReason

public int getReason()

Gets the reason of this PurgeAllowanceException.

Returns:

The reason of this exception

See Also:

INVALID_TO_DATE, PURGE_ALLOWANCES_PROCESS_ALREADY_RUNNING, DISPATCHER_COMMUNICATION_FAILED, UNKNOWN

getMessage

public java.lang.String getMessage()

Gets the message for this PurgeAllowanceException.

Overrides:

getMessage in class java.lang.Throwable

Returns:

The message of this PurgeAllowanceException

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Parameters:

atts - The XML attributes of the current element

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 object, the child representing the marshallable object which must be added to the element.

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, including its children.

Parameters:

output - The XML output to marshal the object into