com.highdeal.bart.hci
Class SearchCDROp

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

public class SearchCDROp
extends java.lang.Object
implements com.highdeal.hci.MessageOperation

The search cdr operation allows to retrieve any cdr using a CDRSearchFilterModel to build search criterias.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="searchCDR">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="cdrSearchFilter" minOccurs="1" maxOccurs="1"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>


Constructor Summary
SearchCDROp()
          Builds an empty SearchCDROp.
 
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.
 CDRSearchFilterModel getFilter()
          Gets the cdr filter.
 java.lang.String getName()
          Gets the name.
 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 setFilter(CDRSearchFilterModel filter)
          Sets the cdr filter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchCDROp

public SearchCDROp()
Builds an empty SearchCDROp.

Method Detail

getName

public java.lang.String getName()
Gets the name.

Specified by:
getName in interface com.highdeal.hci.MessageOperation
Returns:
the name.

getFilter

public CDRSearchFilterModel getFilter()
Gets the cdr filter.

Returns:
the filter to apply.

setFilter

public void setFilter(CDRSearchFilterModel filter)
Sets the cdr filter.

Parameters:
filter - the filter to apply.

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

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