com.highdeal.pnr.hci

Class PreRateException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.highdeal.hci.OperationFailureException

com.highdeal.pnr.hci.PreRateException

All Implemented Interfaces:

OperationResult, XMLMarshallable, Serializable

public class PreRateException
extends OperationFailureException

Exception that may occur during a PreRateOp execution.
This Exception has one of the reasons below:

• invalidReservationUID error occurs when the identifier is null.
• invalidTTL error is related to the ttl that can not be negative.
• invalidDefaultResolution error occurs when the default resolution passed into the PreRateOp is invalid (null or unknown).
• invalidResultType occurs when the result type is unknown.

See Also:

Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="preRateFault">
   <xs:complexType>
     <xs:attribute name="reason" type="PreRateFaultType"/>
     <xs:attribute name="message" type="xs:string"/>
   </xs:complexType>
 </xs:element>

<xs:simpleType name="PreRateFaultType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="invalidReservationUID"/>
     <xs:enumeration value="invalidTTL"/>
     <xs:enumeration value="invalidDefaultResolution"/>
     <xs:enumeration value="invalidResultType"/>
    </xs:restriction>
 </xs:simpleType>

Field Summary

Fields

Modifier and Type	Field and Description
static int	INVALID_DEFAULT_RESOLUTION Constant for invalidDefaultResolution error.
static int	INVALID_RESERVATION_UID Constant for invalidReservationUID error.
static int	INVALID_RESULT_TYPE Constant for invalidResultType error.
static int	INVALID_TTL Constant for invalidTTL error.

Constructor Summary

Constructors

Constructor and Description
PreRateException() Constructs an empty exception.
PreRateException(int reason, String message) Creates a new PreRateException with reason and message

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
String	getMessage() Gets the message for this PreRateException.
int	getReason() Gets the reason of this PreRateException.
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.
void	setMessage(String message) Sets the message for this PreRateException.
void	setReason(int reason) Sets the reason of this PreRateException.
String	toString()

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

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_RESERVATION_UID

public static final int INVALID_RESERVATION_UID

Constant for invalidReservationUID error.

See Also:

Constant Field Values

INVALID_TTL

public static final int INVALID_TTL

Constant for invalidTTL error.

See Also:

Constant Field Values

INVALID_DEFAULT_RESOLUTION

public static final int INVALID_DEFAULT_RESOLUTION

Constant for invalidDefaultResolution error.

See Also:

Constant Field Values

INVALID_RESULT_TYPE

public static final int INVALID_RESULT_TYPE

Constant for invalidResultType error.

See Also:

Constant Field Values

Constructor Detail

PreRateException

public PreRateException()

Constructs an empty exception.

PreRateException

public PreRateException(int reason,
                        String message)

Creates a new PreRateException with reason and message

Parameters:

reason - the reason

message - the additional message

See Also:

INVALID_RESERVATION_UID, INVALID_TTL, INVALID_DEFAULT_RESOLUTION, INVALID_RESULT_TYPE

Method Detail

setReason

public void setReason(int reason)

Sets the reason of this PreRateException.

Parameters:

reason - the reason of this PreRateException

See Also:

INVALID_RESERVATION_UID, INVALID_TTL, INVALID_DEFAULT_RESOLUTION, INVALID_RESULT_TYPE

getReason

public int getReason()

Gets the reason of this PreRateException.

Returns:

the reason of this PreRateException

See Also:

INVALID_RESERVATION_UID, INVALID_TTL, INVALID_DEFAULT_RESOLUTION, INVALID_RESULT_TYPE

setMessage

public void setMessage(String message)

Sets the message for this PreRateException.

Parameters:

message - the message for this PreRateException

getMessage

public String getMessage()

Gets the message for this PreRateException.

Overrides:

getMessage in class Throwable

Returns:

the message of this PreRateException

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(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(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

toString

public String toString()

Overrides:

toString in class Throwable