SAP CC 3.0 BART API

com.highdeal.bart.hci
Class RateCDROp

java.lang.Object
  extended by com.highdeal.bart.hci.RateCDROp

public class RateCDROp
extends java.lang.Object

This operation allows to rate a CDR.

Operation Failure Exception :
InvalidCDRException
RatingErrorException

XML Schema 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
static int DO_MODE
          This is the normal mode.
static int TRY_MODE
          In this mode, no commit is done on each side (SAP Convergent Charging BART and Core).
 
Constructor Summary
RateCDROp()
          Rates a CDR in database Default rating mode is
 
Method Summary
 void addCharacterData(java.lang.String cData)
           
 void addChild(java.lang.String tagName, XMLMarshallable marsh)
           
 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.
 java.util.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 mode of the operation.
 java.lang.String getName()
          Gets the name.
 void marshal(XMLOutputter output)
           
 void setAttributes(XMLAttributes atts)
           
 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 ID.
 void setConsumptionDate(java.util.Date consumptionDate)
          Sets the consumption date of the CDR.
This information will be used in server side in order for better use of database partition.
 void setMode(int ratingMode)
          This mode indicates whether a the rate should be tried without commit or rated definitely - With mode @see #TRY_MODE , the rate is made in TRY mode if there are some duplicate CDR of the deleted one, - With mode @see #DO_MODE , the rate is committed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TRY_MODE

public static final int TRY_MODE
In this mode, no commit is done on each side (SAP Convergent Charging BART and Core).

See Also:
Constant Field Values

DO_MODE

public static final int DO_MODE
This is the normal mode.

See Also:
Constant Field Values
Constructor Detail

RateCDROp

public RateCDROp()
Rates a CDR in database Default rating mode is

See Also:
DO_MODE
Method Detail

getName

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

Returns:
the name.

getCDRID

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

Returns:
the CDR unique ID.

setCDRID

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

Parameters:
id - the CDR unique id.

setConsumptionDate

public void setConsumptionDate(java.util.Date consumptionDate)
Sets the consumption date of the CDR.
This information will be used in server side in order for better use of database partition.

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

getConsumptionDate

public java.util.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(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 Id

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 Id

getMode

public int getMode()
Returns the mode of the operation. - With mode @see #TRY_MODE , the rate is made in TRY mode if there are some duplicate CDR of the deleted one, - With mode @see #DO_MODE , the rate is committed.

Returns:
the mode of the operation.

setMode

public void setMode(int ratingMode)
This mode indicates whether a the rate should be tried without commit or rated definitely - With mode @see #TRY_MODE , the rate is made in TRY mode if there are some duplicate CDR of the deleted one, - With mode @see #DO_MODE , the rate is committed.

Parameters:
ratingMode - the new rating mode

setAttributes

public void setAttributes(XMLAttributes atts)

addCharacterData

public void addCharacterData(java.lang.String cData)

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable marsh)

marshal

public void marshal(XMLOutputter output)

SAP CC 3.0 BART API

(c) Copyright 2011 SAP AG. All rights reserved. SAP Convergent Charging 3.0