com.highdeal.bart.hci

Class InvalidAcquisitionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.highdeal.hci.OperationFailureException

com.highdeal.bart.hci.InvalidAcquisitionException

All Implemented Interfaces:

com.highdeal.hci.OperationResult, XMLMarshallable, java.io.Serializable

public class InvalidAcquisitionException
extends com.highdeal.hci.OperationFailureException

This class implements the methods for the description of an invalid acquisition exception.

See Also:

Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="invalidAcquisitionFault">
   <xs:complexType>
     <xs:attribute name="reason" type="InvalidAcquisitionReasonType"/>
     <xs:attribute name="message" type="xs:string"/>
   </xs:complexType>
 </xs:element>

<xs:simpleType name="InvalidAcquisitionReasonType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="internalError"/>
     <xs:enumeration value="sessionDoesNotExist"/>
     <xs:enumeration value="sessionIsNull"/>
     <xs:enumeration value="sessionIsAlreadyEnded"/>
     <xs:enumeration value="invalidAcquisitionMode"/>
     <xs:enumeration value="tooManyRunningSessions"/>
   </xs:restriction>
 </xs:simpleType>

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACQUISITION_SESSION_ALREADY_ENDED 2: The acquisition is already ended.
static int	ACQUISITION_SESSION_DOES_NOT_EXIST 0: This error occurs when the acquisition session does not exist.
static int	INTERNAL_ERROR -1: Reserved for internal use.
static int	INVALID_ACQUISITION_MODE 3: The specified acquisition mode is invalid.
static java.lang.String	NAME
static int	NULL_ACQUISITION_SESSION 1: The acquisition session in parameter is null.
static int	TOO_MANY_RUNNING_SESSIONS 4: There are too many running acquisition sessions to open a new one.

Constructor Summary

Constructors

Constructor and Description
InvalidAcquisitionException() Builds an empty InvalidAcquisitionException.
InvalidAcquisitionException(int reason) Builds an InvalidAcquisitionException.
InvalidAcquisitionException(int reason, java.lang.String operandReference) Builds an InvalidAcquisitionException.

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.
java.lang.String	getOperandReference()
int	getReason() Returns the reason of the 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.
java.lang.String	toString() Returns the reason of the exception in readable format.

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

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

Field Detail

INTERNAL_ERROR

public static final int INTERNAL_ERROR

-1: Reserved for internal use.

See Also:

Constant Field Values

ACQUISITION_SESSION_DOES_NOT_EXIST

public static final int ACQUISITION_SESSION_DOES_NOT_EXIST

0: This error occurs when the acquisition session does not exist.

See Also:

Constant Field Values

NULL_ACQUISITION_SESSION

public static final int NULL_ACQUISITION_SESSION

1: The acquisition session in parameter is null.

See Also:

Constant Field Values

ACQUISITION_SESSION_ALREADY_ENDED

public static final int ACQUISITION_SESSION_ALREADY_ENDED

2: The acquisition is already ended.

See Also:

Constant Field Values

INVALID_ACQUISITION_MODE

public static final int INVALID_ACQUISITION_MODE

3: The specified acquisition mode is invalid.

See Also:

Constant Field Values

TOO_MANY_RUNNING_SESSIONS

public static final int TOO_MANY_RUNNING_SESSIONS

4: There are too many running acquisition sessions to open a new one.

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

InvalidAcquisitionException

public InvalidAcquisitionException()

Builds an empty InvalidAcquisitionException.

InvalidAcquisitionException

public InvalidAcquisitionException(int reason)

Builds an InvalidAcquisitionException.

Parameters:

reason - The reason of the exception

InvalidAcquisitionException

public InvalidAcquisitionException(int reason,
                                   java.lang.String operandReference)

Builds an InvalidAcquisitionException.

Parameters:

reason - The reason of the exception

operandReference - An operand reference such as faultly session ID or description message

Method Detail

getReason

public int getReason()

Returns the reason of the exception.

Returns:

The reason of the exception

getOperandReference

public java.lang.String getOperandReference()

Specified by:

getOperandReference in interface com.highdeal.hci.OperationResult

Overrides:

getOperandReference in class com.highdeal.hci.OperationFailureException

toString

public java.lang.String toString()

Returns the reason of the exception in readable format.

Overrides:

toString in class java.lang.Throwable

Returns:

A string describing the reason of the exception

getMessage

public java.lang.String getMessage()

Gets the message.

Overrides:

getMessage in class java.lang.Throwable

Returns:

The message

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

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

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

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