Package com.highdeal.pnr.hci

Class StopRateException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.highdeal.hci.OperationFailureException

com.highdeal.pnr.hci.StopRateException

All Implemented Interfaces:

OperationResult, XMLMarshallable, Serializable

public class StopRateException
extends OperationFailureException

The exception for the StopRateOp operation.

See Also:

• Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="stopRateFault">
   <xs:complexType>
     <xs:attribute name="reason" type="StopRateFaultType"/>
     <xs:attribute name="message" type="xs:string"/>
   </xs:complexType>
 </xs:element>

<xs:simpleType name="StopRateFaultType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="invalidSessionID"/>
     <xs:enumeration value="invalidResolution"/>
     <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_RESOLUTION	The resolution code isn't a valid one.
static final int	INVALID_RESULT_TYPE	the result type isn't a valid one;
static final int	INVALID_SESSION_ID	The session isn't valid or missing for instance.
static final int	NO_SESSION_FOUND	The sessions isn't found.
static final int	NOT_ENOUGH_SPACE	There isn't 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
StopRateException()	Constructs an empty stop exception.
StopRateException(int reason, String message)	Constructs an stop exception with a reason and a message.

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.
String	getMessage()
String	getName()
int	getReason()	Gets the reason.
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.
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 isn't valid or missing for instance.

See Also:

• Constant Field Values

INVALID_RESOLUTION

public static final int INVALID_RESOLUTION

The resolution code isn't a valid one.

See Also:

• Constant Field Values

INVALID_RESULT_TYPE

public static final int INVALID_RESULT_TYPE

the result type isn't a valid one;

See Also:

• Constant Field Values

NO_SESSION_FOUND

public static final int NO_SESSION_FOUND

The sessions isn't found.

See Also:

• Constant Field Values

NOT_ENOUGH_SPACE

public static final int NOT_ENOUGH_SPACE

There isn't 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

StopRateException

public StopRateException()

Constructs an empty stop exception.

StopRateException

public StopRateException(int reason,
 String message)

Constructs an stop 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_RESOLUTION
• INVALID_RESULT_TYPE
• INVALID_SESSION_ID
• NO_SESSION_FOUND
• NOT_ENOUGH_SPACE

Parameters:

reason - the reason.

getReason

public int getReason()

Gets the reason.

• INVALID_RESOLUTION
• INVALID_RESULT_TYPE
• INVALID_SESSION_ID
• NO_SESSION_FOUND
• NOT_ENOUGH_SPACE

Returns:

the reason.

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