Package com.highdeal.bart.hci

Class StopAcquisitionSessionOp

java.lang.Object
com.highdeal.bart.hci.StopAcquisitionSessionOp
All Implemented Interfaces:
com.highdeal.hci.MessageOperation, XMLMarshallable
public class StopAcquisitionSessionOp extends Object implements com.highdeal.hci.MessageOperation
This operation allows to stop an acquisition session.

Operation Failure Exceptions

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="stopAcquisitionSession">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="acquisition"  minOccurs="1" maxOccurs="1"/>
     </xs:sequence>
     <xs:attribute name="withErrors" type="xs:boolean"/>
   </xs:complexType>
 </xs:element>

  • Constructor Details

    • StopAcquisitionSessionOp

      public StopAcquisitionSessionOp()
      Stops an acquisition session .

  • Method Details

    • getName

      public String getName()
      Gets the name.
      Specified by:
      getName in interface com.highdeal.hci.MessageOperation
      Returns:
      the name.

    • getAcquisitionSession

      public AcquisitionSessionModel getAcquisitionSession()
      Gets the acquisition session .
      Returns:
      the acquisition session.

    • setAcquisitionSession

      public void setAcquisitionSession(AcquisitionSessionModel asm)
      Sets the acquisition session.
      Parameters:
      asm - the acquisition session.

    • setWithErrors

      public void setWithErrors(boolean b)
      Sets whether this session has encountered errors or not
      Parameters:
      b -

    • hasErrors

      public boolean hasErrors()
      Tells whether this session has encountered errors or not

    • setAttributes

      public void setAttributes(XMLAttributes atts)
      Description copied from interface: XMLMarshallable
      Sets the attributes of the XML representation of the element being processed.
      Specified by:
      setAttributes in interface XMLMarshallable
      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.
      Specified by:
      addCharacterData in interface XMLMarshallable
      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.
      Specified by:
      addChild in interface XMLMarshallable
      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.
      Specified by:
      marshal in interface XMLMarshallable
      Parameters:
      output - The XML output to marshal the object into