com.highdeal.bart.hci
Class AcquireCDRResult

java.lang.Object
  extended by com.highdeal.bart.hci.AcquireCDRResult
All Implemented Interfaces:
com.highdeal.hci.OperationResult, XMLMarshallable

public class AcquireCDRResult
extends java.lang.Object
implements com.highdeal.hci.OperationResult

This class represents the result of the Acquire CDR operation and contains a sequence of CDRs which have been acquired by the connected SAP CC BART Server system.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="acquireCDRResult">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="cdr" minOccurs="1" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="hasDuplicate" type="HasDuplicate"/>
     <xs:attribute name="nbCDRNew" type="xs:string"/>
     <xs:attribute name="nbCDRDuplicate" type="xs:string"/>
   </xs:complexType>
 </xs:element>
<xs:simpleType name="HasDuplicate">
   <xs:restriction base="xs:string">
     <xs:enumeration value="true"/>
     <xs:enumeration value="false"/>
   </xs:restriction>
 </xs:simpleType>


Constructor Summary
AcquireCDRResult()
          Builds an empty AcquireCDRResult.
 
Method Summary
 void addCharacterData(java.lang.String cData)
          Adds character data to the content element.
 void addChild(java.lang.String tagName, XMLMarshallable child)
          Adds a child to the object, the child representing the marshallable object which must be added to the element.
 CDRModel getCDR()
          Gets the first CDR.
 java.util.Vector<CDRModel> getCDRs()
          Gets the list of CDRs; This method must be called by the client, if the current operation on CDRs must return a list of CDRs.
 long getNbCDRDuplicate()
          Gets the number of duplicate CDRs for this acquition operation.
 long getNbCDRNew()
          Gets the number of new CDRs for this acquition operation.
 java.lang.String getOperandReference()
           
 boolean hasDuplicate()
          Gets the has duplicate status for this acquisition operation.
 void marshal(XMLOutputter output)
          Gives an XML representation of this object, including its children.
 void setAttributes(XMLAttributes atts)
          Sets the attributes of the XML representation of the element being processed.
 void setCDR(CDRModel cdr)
          Sets the cdr (Internal Use Only).
 void setCDRs(java.util.Vector<CDRModel> list)
          Sets the list of CDRs.
 void setNbCDRDuplicate(long nbCDRDuplicate)
          Sets the number of duplicate CDRs for this acquition operation (Internal Use Only).
 void setNbCDRNew(long nbCDRNew)
          Sets the number of new CDRs for this acquition operation (Internal Use Only).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AcquireCDRResult

public AcquireCDRResult()
Builds an empty AcquireCDRResult.

Method Detail

setCDRs

public void setCDRs(java.util.Vector<CDRModel> list)
Sets the list of CDRs.

Parameters:
list - A vector of CDRs

getCDRs

public java.util.Vector<CDRModel> getCDRs()
Gets the list of CDRs; This method must be called by the client, if the current operation on CDRs must return a list of CDRs.

Returns:
A vector of CDRs

getCDR

public CDRModel getCDR()
Gets the first CDR.

Returns:
The first CDR

setCDR

public void setCDR(CDRModel cdr)
Sets the cdr (Internal Use Only).

Parameters:
cdr - The CDR

hasDuplicate

public boolean hasDuplicate()
Gets the has duplicate status for this acquisition operation.

Returns:
true if at least one of the CDRs submitted is a duplicate.

getNbCDRDuplicate

public long getNbCDRDuplicate()
Gets the number of duplicate CDRs for this acquition operation.

Returns:
The number of duplicate CDRs for this acquition operation

setNbCDRDuplicate

public void setNbCDRDuplicate(long nbCDRDuplicate)
Sets the number of duplicate CDRs for this acquition operation (Internal Use Only). param The number of duplicate CDRs for this acquition operation


getNbCDRNew

public long getNbCDRNew()
Gets the number of new CDRs for this acquition operation.

Returns:
The number of new CDRs for this acquition operation

setNbCDRNew

public void setNbCDRNew(long nbCDRNew)
Sets the number of new CDRs for this acquition operation (Internal Use Only). param The number of new CDRs for this acquition operation


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(java.lang.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(java.lang.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 java.lang.String getOperandReference()
Specified by:
getOperandReference in interface com.highdeal.hci.OperationResult

Document Published: October 2015 (SAP CC 4.0 SP10 and Later)