Package com.highdeal.bart.hci

Class ModifyCDRBulkOp

java.lang.Object
com.highdeal.bart.hci.ModifyCDRBulkOp
All Implemented Interfaces:
com.highdeal.hci.MessageOperation, XMLMarshallable
public class ModifyCDRBulkOp extends Object implements com.highdeal.hci.MessageOperation
The modify CDR bulk operation allows to modify any CDR objects in a bulk way by specifying a search filter model.

2 main parameters are required for this operation:

  • A search filter (CDRSearchFilterModel) which will allows the caller to select the CDRs on which the modifications will occur.
  • A modification model (CDRModificationModel) which will describe all modification which must be performed on selected CDRs.

The "mode" attribute is optional. If it is not specified the "modifyAndDeduplicate" value will be used.


Operation Failure Exceptions

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="modifyCDRBulk">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="SearchFilter" minOccurs="1" maxOccurs="1"/>
       <xs:element ref="ModificationModel" minOccurs="1" maxOccurs="1"/>
     </xs:sequence>
     <xs:attribute name="mode" type="BulkModificationModeType"/>
   </xs:complexType>
 </xs:element>
<xs:simpleType name="BulkModificationModeType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="modify"/>
     <xs:enumeration value="modifyAndDeduplicate"/>
   </xs:restriction>
 </xs:simpleType>

  • Field Details

    • mode

      protected int mode

    • MODIFY_MODE

      public static final int MODIFY_MODE
      After the modification is done, no de-duplication detection is performed.
      See Also:

    • MODIFY_AND_DEDUPLICATE_MODE

      public static final int MODIFY_AND_DEDUPLICATE_MODE
      After the modificaiton is done, a de-duplication detection is performed.
      See Also:

  • Constructor Details

    • ModifyCDRBulkOp

      public ModifyCDRBulkOp()
      Builds an empty ModifyCDRBulkOp.

  • Method Details

    • getName

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

    • getFilter

      public CDRSearchFilterModel getFilter()
      Gets the search filter.
      Returns:
      the filter to apply.

    • setFilter

      public void setFilter(CDRSearchFilterModel filter)
      Sets the search filter.
      Parameters:
      filter - the filter to apply.

    • getModification

      public CDRModificationModel getModification()
      Gets the modification plan.
      Returns:
      the modification plan.

    • setModification

      public void setModification(CDRModificationModel plan)
      Sets the modification plan.
      Parameters:
      plan - the plan to apply for modification.

    • getMode

      public int getMode()
      Gets the modification mode
      Returns:
      mode

    • setMode

      public void setMode(int modificationMode)
      This indicates whether a deduplicate process should be made when modifying a CDR
      Parameters:
      modificationMode -

    • 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