Package com.highdeal.bart.hci

Class AcquisitionSessionOperationResult

java.lang.Object
com.highdeal.bart.hci.AcquisitionSessionOperationResult
All Implemented Interfaces:
com.highdeal.hci.OperationResult, XMLMarshallable
Direct Known Subclasses:
StartAcquisitionSessionResult, StopAcquisitionSessionResult
public abstract class AcquisitionSessionOperationResult extends Object implements com.highdeal.hci.OperationResult
This class is a generic abstract class for the results returned by operations on AcquisitionSession.
  • If the current operation on AcquisitionSession must return a list of sessions, please use getAcquisitionSessions() method for the result obtention.
  • If the current operation on AcquisitionSession must returns only one AcquisitionSession, please use gesAcquisitionSession() method for the result obtention.

  • Constructor Details

    • AcquisitionSessionOperationResult

      public AcquisitionSessionOperationResult(String resultTagName, boolean singleton)
      Builds an AcquisitionSessionOperationResult without session.
      Parameters:
      resultTagName - the operation result name.
      singleton - is at true if there is only one result(session).

  • Method Details

    • setAcquisitionSessions

      public void setAcquisitionSessions(Vector<AcquisitionSessionModel> list)
      Sets the acquisition session list.
      Parameters:
      list - a vector of AcquisitionSessionModel.

    • getAcquisitionSessions

      public Vector<AcquisitionSessionModel> getAcquisitionSessions()
      Gets the acquisition session list. This method must be called by the client, if the current operation on sessions must return a list of sessions.
      Returns:
      a vector of AcquisitionSessionModel.

    • getAcquisitionSession

      public AcquisitionSessionModel getAcquisitionSession()
      Gets the AcquisitionSessionModel. This method must be called by the client, if the current operation on AcquisitionSessionModels must return a single AcquisitionSessionModel.
      Returns:
      the AcquisitionSessionModel.

    • setAcquisitionSession

      public void setAcquisitionSession(AcquisitionSessionModel session)

    • 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

    • getOperandReference

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