com.highdeal.bart.hci
Class DeleteCDROp

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

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

This operation requests the BART Server system to delete a CDR stored in the back-end BART Database.

Operation Failure Exception

InvalidAcquisitionException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="deleteCDR">
   <xs:complexType>
     <xs:attribute name="cdrID" type="xs:string"/>
     <xs:attribute name="consumptionDate" type="xs:dateTime" use="optional"/>
     <xs:attribute name="batchRatingGroupId" type="xs:integer" use="optional"/>
     <xs:attribute name="mode" type="DeletionModeType"/>
   </xs:complexType>
 </xs:element>
<xs:simpleType name="DeletionModeType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="delete"/>
     <xs:enumeration value="deleteAndDeduplicate"/>
   </xs:restriction>
 </xs:simpleType>


Field Summary
static int DELETE_AND_DEDUPLICATE_MODE
          Deletion mode of the SAP CC BART Server system that searches for duplicates after the deletion; This is the default deletion mode.
static int DELETE_MODE
          Deletion mode of the SAP CC BART Server system that does not search for duplicates after the deletion
 
Constructor Summary
DeleteCDROp()
          Deletes a CDR in background BART Database; Default deletion mode is
 
Method Summary
 void addCharacterData(java.lang.String cData)
          Adds character data to the content element.
 void addChild(java.lang.String tagName, XMLMarshallable marsh)
          Adds a child to the object, the child representing the marshallable object which must be added to the element.
 java.lang.Integer getBatchRatingGroupId()
          Gets the batch rating group ID.
This information will be used in server side in order for better use of database partition.
 java.lang.Long getCDRID()
          Gets the CDR unique ID
 java.util.Date getConsumptionDate()
          Gets the consumption date of the CDR; BART Server uses this information to organize the database partitions.
 int getMode()
          Returns the deletion mode currently set DELETE_AND_DEDUPLICATE_MODE: If there are some duplicate CDRs of the deleted one, the one with the oldest acquisition date is marked as new DELETE_MODE: the CDR is deleted regardless of any existing duplicates
 java.lang.String getName()
          Gets the operation 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 setBatchRatingGroupId(java.lang.Integer batchRatingGroupId)
          Sets the batch rating group ID.
This information will be used in server side in order for better use of database partition.
 void setCDRID(java.lang.Long id)
          Sets the CDR unique ID
 void setConsumptionDate(java.util.Date consumptionDate)
          Sets the consumption date of the CDR; BART Server uses this information to organize the database partitions.
 void setMode(int deletionMode)
          Sets the execution mode of the deletion request; This deletion mode indicates whether a deduplicate process should be made after a CDR is deleted by the distant SAP CC system.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DELETE_MODE

public static final int DELETE_MODE
Deletion mode of the SAP CC BART Server system that does not search for duplicates after the deletion

See Also:
Constant Field Values

DELETE_AND_DEDUPLICATE_MODE

public static final int DELETE_AND_DEDUPLICATE_MODE
Deletion mode of the SAP CC BART Server system that searches for duplicates after the deletion; This is the default deletion mode.

See Also:
Constant Field Values
Constructor Detail

DeleteCDROp

public DeleteCDROp()
Deletes a CDR in background BART Database; Default deletion mode is

See Also:
DELETE_AND_DEDUPLICATE_MODE
Method Detail

getName

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

Specified by:
getName in interface com.highdeal.hci.MessageOperation
Returns:
The name of the operation: deleteCDR

getCDRID

public java.lang.Long getCDRID()
Gets the CDR unique ID

Returns:
The CDR unique identifier

setCDRID

public void setCDRID(java.lang.Long id)
Sets the CDR unique ID

Parameters:
id - The CDR unique identifier

setConsumptionDate

public void setConsumptionDate(java.util.Date consumptionDate)
Sets the consumption date of the CDR; BART Server uses this information to organize the database partitions.

Parameters:
consumptionDate - The consumption date of the CDR to modify

getConsumptionDate

public java.util.Date getConsumptionDate()
Gets the consumption date of the CDR; BART Server uses this information to organize the database partitions.

Returns:
The consumption date of the CDR

setBatchRatingGroupId

public void setBatchRatingGroupId(java.lang.Integer batchRatingGroupId)
Sets the batch rating group ID.
This information will be used in server side in order for better use of database partition.

Parameters:
batchRatingGroupId - The batch rating group identifier

getBatchRatingGroupId

public java.lang.Integer getBatchRatingGroupId()
Gets the batch rating group ID.
This information will be used in server side in order for better use of database partition.

Returns:
batchRatingGroupId The batch rating group identifier

getMode

public int getMode()
Returns the deletion mode currently set DELETE_AND_DEDUPLICATE_MODE: If there are some duplicate CDRs of the deleted one, the one with the oldest acquisition date is marked as new DELETE_MODE: the CDR is deleted regardless of any existing duplicates

Returns:
The deletion mode

setMode

public void setMode(int deletionMode)
Sets the execution mode of the deletion request; This deletion mode indicates whether a deduplicate process should be made after a CDR is deleted by the distant SAP CC system. DELETE_AND_DEDUPLICATE_MODE: If there are some duplicate CDRs of the deleted one, the one with the oldest acquisition date is marked as new DELETE_MODE: The CDR is deleted regardless of any existing duplicates

Parameters:
deletionMode - The deletion mode

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 marsh)
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
marsh - 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)