com.highdeal.bart.hci
Class InvalidAcquisitionException

java.lang.Object
  OperationFailureException
      com.highdeal.bart.hci.InvalidAcquisitionException

public class InvalidAcquisitionException
extends OperationFailureException

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

XML Schema 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

static int	ACQUISITION_SESSION_ALREADY_ENDED The acquisition is already ended.
static int	ACQUISITION_SESSION_DOES_NOT_EXIST This error occurs when the acquisition session does not exist.
static int	INTERNAL_ERROR Reserved for internal use.
static int	INVALID_ACQUISITION_MODE The given acquisition mode is invalid.
static java.lang.String	NAME
static int	NULL_ACQUISITION_SESSION The acquisition session in parameter is null.
static int	TOO_MANY_RUNNING_SESSIONS There are too many running acquisition sessions to open a new one.

Constructor Summary

InvalidAcquisitionException()
Builds an empty InvalidAcquisitionException.

InvalidAcquisitionException(int reason)
Builds an InvalidAcquisitionException.

InvalidAcquisitionException(int reason, java.lang.String operandReference)
Builds an InvalidAcquisitionException.

Method Summary

void	addCharacterData(java.lang.String cData)
void	addChild(java.lang.String tagName, XMLMarshallable child)
java.lang.String	getMessage() Gets the message.
java.lang.String	getOperandReference()
int	getReason() Returns the reason of the exception.
void	marshal(XMLOutputter output)
void	setAttributes(XMLAttributes atts)
java.lang.String	toString() Returns the reason of the exception in readable format.

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

Reserved for internal use.

See Also:

Constant Field Values

ACQUISITION_SESSION_DOES_NOT_EXIST

public static final int ACQUISITION_SESSION_DOES_NOT_EXIST

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

The acquisition session in parameter is null.

See Also:

Constant Field Values

ACQUISITION_SESSION_ALREADY_ENDED

public static final int ACQUISITION_SESSION_ALREADY_ENDED

The acquisition is already ended.

See Also:

Constant Field Values

INVALID_ACQUISITION_MODE

public static final int INVALID_ACQUISITION_MODE

The given acquisition mode is invalid.

See Also:

Constant Field Values

TOO_MANY_RUNNING_SESSIONS

public static final int TOO_MANY_RUNNING_SESSIONS

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

toString

public java.lang.String toString()

Returns the reason of the exception in readable format.

Returns:

a string describing the reason of the exception.

getMessage

public java.lang.String getMessage()

Gets the message.

Returns:

the message.

setAttributes

public void setAttributes(XMLAttributes atts)

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

addCharacterData

public void addCharacterData(java.lang.String cData)

marshal

public void marshal(XMLOutputter output)