Package com.highdeal.bart.hci

Class AcquireCDROp

java.lang.Object
com.highdeal.bart.hci.AcquireCDROp
All Implemented Interfaces:
com.highdeal.hci.MessageOperation, XMLMarshallable
public class AcquireCDROp extends Object implements com.highdeal.hci.MessageOperation
This operation allows you to trigger the acquisition of CDRs as part of a started acquisition session. It is one of the three operations of the acquisition process. See AcquisitionSessionModel for more information.

Operation Failure Exceptions

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="acquireCDR">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="cdr" minOccurs="1" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="sessionID" type="xs:string" use="required"/>
   </xs:complexType>
 </xs:element>

  • Constructor Details

    • AcquireCDROp

      public AcquireCDROp()
      Builds an empty operation.

  • Method Details

    • getName

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

    • getCDR

      public CDRModel getCDR()
      Gets the first element of CDR list.
      Returns:
      The first CDR contained by the operation

    • getCDRs

      public Vector<CDRModel> getCDRs()
      Gets the CDRs list.
      Returns:
      A vector of CDR

    • setCDR

      public void setCDR(CDRModel cdr)
      Sets the CDR.
      Parameters:
      cdr - The CDR

    • setCDRs

      public void setCDRs(Vector<CDRModel> cdrs)
      Sets the CDRs list.
      Parameters:
      cdrs - A vector of CDRs

    • addCDR

      public void addCDR(CDRModel cdr)
      Adds a CDR to the list.
      Parameters:
      cdr - The CDR to add

    • getAcquisitionSession

      @Deprecated public AcquisitionSessionModel getAcquisitionSession()
      Deprecated.
      Use getAcquisitionSessionID() instead
      Gets the acquisition session.
      Returns:
      The acquisition session

    • getAcquisitionSessionID

      public Long getAcquisitionSessionID()
      Gets the acquisition session unique ID.
      Returns:
      The acquisition session unique ID

    • setAcquisitionSession

      public void setAcquisitionSession(AcquisitionSessionModel asm)
      Sets the acquisition session; Use this method or setAcquisitionSessionID(Long sessionID) to set the session these CDRs will be linked to.
      Parameters:
      asm - The acquisition session

    • setAcquisitionSessionID

      public void setAcquisitionSessionID(Long sessionID)
      Sets the acquisition session unique ID; Use this method or setAcquisitionSession(AcquisitionSessionModel asm) to set the session these CDRs will be linked to.
      Parameters:
      sessionID - The acquisition session unique ID

    • 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