Package com.highdeal.bart.hci

Class RateCDROp

java.lang.Object
com.highdeal.bart.hci.RateCDROp
All Implemented Interfaces:
com.highdeal.hci.MessageOperation, XMLMarshallable
public class RateCDROp extends Object implements com.highdeal.hci.MessageOperation
This operation allows to rate and charge a CDR.

Operation Failure Exceptions

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="rateCDR">
   <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="RateCDRRatingModeType"/>
   </xs:complexType>
 </xs:element>
<xs:simpleType name="RateCDRRatingModeType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="try"/>
     <xs:enumeration value="do"/>
   </xs:restriction>
 </xs:simpleType>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DO_MODE
    DO_MODE is the normal and default execution mode of the charging operation: Resulting changes are committed by the systems.
    static final int
    TRY_MODE
    No commit is done on each side (SAP CC BART Server and SAP CC Core Server)

  • Constructor Summary

    Constructors
    Constructor
    Description
    RateCDROp()
    Rates and charges a single CDR stored in the BART Database; Default rating execution mode is: DO_MODE.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addCharacterData(String cData)
    Adds character data to the content element.
    void
    addChild(String tagName, XMLMarshallable marsh)
    Adds a child to the object, the child representing the marshallable object which must be added to the element.
    Integer
    getBatchRatingGroupId()
    Gets the batch rating group ID; This information will be used in server side in order for better use of database partition.
    Long
    getCDRID()
    Gets the identifier of the CDR
    Date
    getConsumptionDate()
    Gets the consumption date of the CDR; This information will be used in server side in order for better use of database partition.
    int
    getMode()
    Returns the execution mode currently set for the operation request; See setMode(int) for more information.
    String
    getName()
    Gets the technical name of the 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
    setBatchRatingGroupId(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(Long id)
    Sets the CDR ID
    void
    setConsumptionDate(Date consumptionDate)
    Sets the consumption date of the CDR; This information will be used in the SAP CC BART Server system to improve the organization of the BART Database partition.
    void
    setMode(int ratingMode)
    Speficies the execution mode of the charging operation; This mode indicates whether the rate should be tried without commit or rated definitely Mode TRY: The SAP CC Core Server system processes the charging in a TRY mode if there are some duplicate CDR of the deleted one, Mode DO: The SAP CC Core Server system processes the charging and commits the resulting changes; Charged transactions are generated and stored in data files

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • TRY_MODE

      public static final int TRY_MODE
      No commit is done on each side (SAP CC BART Server and SAP CC Core Server)
      See Also:

    • DO_MODE

      public static final int DO_MODE
      DO_MODE is the normal and default execution mode of the charging operation: Resulting changes are committed by the systems.
      See Also:

  • Constructor Details

    • RateCDROp

      public RateCDROp()
      Rates and charges a single CDR stored in the BART Database; Default rating execution mode is: DO_MODE.

  • Method Details

    • getName

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

    • getCDRID

      public Long getCDRID()
      Gets the identifier of the CDR
      Returns:
      The CDR unique ID

    • setCDRID

      public void setCDRID(Long id)
      Sets the CDR ID
      Parameters:
      id - The CDR unique identifier

    • setConsumptionDate

      public void setConsumptionDate(Date consumptionDate)
      Sets the consumption date of the CDR; This information will be used in the SAP CC BART Server system to improve the organization of the BART Database partition.
      Parameters:
      consumptionDate - The consumption date of the CDR to modify

    • getConsumptionDate

      public Date getConsumptionDate()
      Gets the consumption date of the CDR; This information will be used in server side in order for better use of database partition.
      Returns:
      The consumption date of the CDR

    • setBatchRatingGroupId

      public void setBatchRatingGroupId(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 identifier of the batch rating group

    • getBatchRatingGroupId

      public 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 identifier of the batch rating group

    • getMode

      public int getMode()
      Returns the execution mode currently set for the operation request; See setMode(int) for more information.
      Returns:
      The execution mode of the operation
      See Also:

    • setMode

      public void setMode(int ratingMode)
      Speficies the execution mode of the charging operation; This mode indicates whether the rate should be tried without commit or rated definitely
      • Mode TRY: The SAP CC Core Server system processes the charging in a TRY mode if there are some duplicate CDR of the deleted one,
      • Mode DO: The SAP CC Core Server system processes the charging and commits the resulting changes; Charged transactions are generated and stored in data files
      Parameters:
      ratingMode - The new rating 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(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 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