Package com.highdeal.pnr.hci

Class UpdateRateException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.highdeal.hci.OperationFailureException

com.highdeal.pnr.hci.UpdateRateException

All Implemented Interfaces:

OperationResult, XMLMarshallable, Serializable

public class UpdateRateException
extends OperationFailureException

Exception thrown when the Update Rate operation failed due to several possible reasons.

See Also:

• Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="updateRateFault">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="serverFault" minOccurs="0" maxOccurs="1"/>
       <xs:element ref="stopRateFault" minOccurs="0" maxOccurs="1"/>
       <xs:element ref="startRateFault" minOccurs="0" maxOccurs="1"/>
       <xs:element ref="stopRateResult" minOccurs="0" maxOccurs="1"/>
     </xs:sequence>
     <xs:attribute name="reason" type="UpdateRateFaultType"/>
     <xs:attribute name="message" type="xs:string"/>
   </xs:complexType>
 </xs:element>

<xs:simpleType name="UpdateRateFaultType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="invalidSessionID"/>
     <xs:enumeration value="invalidResultType"/>
     <xs:enumeration value="noSessionFound"/>
     <xs:enumeration value="notEnoughSpace"/>
     <xs:enumeration value="sessionNotAccessible"/>
    </xs:restriction>
 </xs:simpleType>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	INVALID_RESULT_TYPE	The result type is not a valid one.
static final int	INVALID_SESSION_ID	The session is not valid or missing for instance.
static final int	NO_SESSION_FOUND	The session is not found.
static final int	NOT_ENOUGH_SPACE	There is not enough space on to store a session.
static final int	SESSION_NOT_ACCESSIBLE	The session is linked to an access different than those of the update operation.

Constructor Summary

Constructors

Constructor	Description
UpdateRateException()	Constructs an empty udpate exception.
UpdateRateException(int reason, String message)	Constructs an udpate exception with a reason and a message.
UpdateRateException(int reason, String message, StartRateException e)	Constructs an udpate exception with a reason and a message.
UpdateRateException(int reason, String message, StopRateException e)	Constructs an udpate exception with a reason and a message.
UpdateRateException(ServerFailureException e)	Constructs an udpate exception from a server failure exception on a start rate.
UpdateRateException(StartRateException e)	Constructs an udpate exception from a start rate exception.
UpdateRateException(StopRateException e)	Constructs an udpate exception from a stop rate exception.

Method Summary

Modifier and Type	Method	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.
OperationFailureException	getExceptionOrigin()	Gets the exception origin (StopRateException, StartRateException or ServerFailureException).
String	getMessage()
String	getName()
int	getReason()	Gets the reason.
StopRateResult	getStopRateResult()	Gets the stop rate result if the exception origin is a StartRateException exception or a ServerFailureException exception.
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	setReason(int reason)	Sets the reason.
void	setStopRateResult(StopRateResult result)	Sets the stop rate result.
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 Details

INVALID_SESSION_ID

public static final int INVALID_SESSION_ID

The session is not valid or missing for instance.

See Also:

• Constant Field Values

INVALID_RESULT_TYPE

public static final int INVALID_RESULT_TYPE

The result type is not a valid one.

See Also:

• Constant Field Values

NO_SESSION_FOUND

public static final int NO_SESSION_FOUND

The session is not found.

See Also:

• Constant Field Values

NOT_ENOUGH_SPACE

public static final int NOT_ENOUGH_SPACE

There is not enough space on to store a session.

See Also:

• Constant Field Values

SESSION_NOT_ACCESSIBLE

public static final int SESSION_NOT_ACCESSIBLE

The session is linked to an access different than those of the update operation.

See Also:

• Constant Field Values

Constructor Details

UpdateRateException

public UpdateRateException()

Constructs an empty udpate exception.

UpdateRateException

public UpdateRateException(StopRateException e)

Constructs an udpate exception from a stop rate exception.

UpdateRateException

public UpdateRateException(StartRateException e)

Constructs an udpate exception from a start rate exception.

UpdateRateException

public UpdateRateException(ServerFailureException e)

Constructs an udpate exception from a server failure exception on a start rate.

UpdateRateException

public UpdateRateException(int reason,
 String message)

Constructs an udpate exception with a reason and a message.

Parameters:

reason - The reason

message - The message

UpdateRateException

public UpdateRateException(int reason,
 String message,
 StopRateException e)

Constructs an udpate exception with a reason and a message.

Parameters:

reason - The reason

message - The message

UpdateRateException

public UpdateRateException(int reason,
 String message,
 StartRateException e)

Constructs an udpate exception with a reason and a message.

Parameters:

reason - The reason

message - The message

Method Details

getName

public String getName()

setReason

public void setReason(int reason)

Sets the reason.

• INVALID_RESULT_TYPE
• INVALID_SESSION_ID
• NO_SESSION_FOUND
• NOT_ENOUGH_SPACE
• SESSION_NOT_ACCESSIBLE

Parameters:

reason - The reason

getReason

public int getReason()

Gets the reason.

• INVALID_RESULT_TYPE
• INVALID_SESSION_ID
• NO_SESSION_FOUND
• NOT_ENOUGH_SPACE
• SESSION_NOT_ACCESSIBLE

Returns:

The reason

getExceptionOrigin

public OperationFailureException getExceptionOrigin()

Gets the exception origin (StopRateException, StartRateException or ServerFailureException).

Returns:

Can be null

getStopRateResult

public StopRateResult getStopRateResult()

Gets the stop rate result if the exception origin is a StartRateException exception or a ServerFailureException exception.

Returns:

The stop rate result

setStopRateResult

public void setStopRateResult(StopRateResult result)

Sets the stop rate result.

Parameters:

result -

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

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