Package 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, Serializable
public class InvalidAcquisitionException extends com.highdeal.hci.OperationFailureException
This class implements the methods for the description of an invalid acquisition exception.
See Also:

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 Details

    • INTERNAL_ERROR

      public static final int INTERNAL_ERROR
      -1: Reserved for internal use.
      See Also:

    • 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:

    • NULL_ACQUISITION_SESSION

      public static final int NULL_ACQUISITION_SESSION
      1: The acquisition session in parameter is null.
      See Also:

    • ACQUISITION_SESSION_ALREADY_ENDED

      public static final int ACQUISITION_SESSION_ALREADY_ENDED
      2: The acquisition is already ended.
      See Also:

    • INVALID_ACQUISITION_MODE

      public static final int INVALID_ACQUISITION_MODE
      3: The specified acquisition mode is invalid.
      See Also:

    • 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:

    • NAME

      public static final String NAME
      See Also:

  • Constructor Details

    • 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, 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 Details

    • getReason

      public int getReason()
      Returns the reason of the exception.
      Returns:
      The reason of the exception

    • getOperandReference

      public String getOperandReference()
      Specified by:
      getOperandReference in interface com.highdeal.hci.OperationResult
      Overrides:
      getOperandReference in class com.highdeal.hci.OperationFailureException

    • toString

      public String toString()
      Returns the reason of the exception in readable format.
      Overrides:
      toString in class Throwable
      Returns:
      A string describing the reason of the exception

    • getMessage

      public String getMessage()
      Gets the message.
      Overrides:
      getMessage in class 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(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(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