SAP CC 1.0
API 4.2 (Core)

com.highdeal.pnr.hci
Class UpdateRateResult

java.lang.Object
  extended by com.highdeal.pnr.hci.UpdateRateResult
All Implemented Interfaces:
OperationResult, XMLMarshallable

public class UpdateRateResult
extends java.lang.Object
implements OperationResult

The result of a UpdateRateOp operation.


XML Schema Fragment
<xs:element name="updateRateResult"> 
   <xs:complexType>
     <xs:sequence> 
       <xs:element name="transacSetToCleanup" type="TransactionSetType" minOccurs="0" maxOccurs="unbounded"/>
       <xs:element name="transacSetToConfirm" type="TransactionSetType" minOccurs="0" maxOccurs="unbounded"/>
       <xs:element name="transacSetToReserve" type="TransactionSetType" minOccurs="0" maxOccurs="unbounded"/>
       <xs:element name="transacSetToCancel"  type="TransactionSetType" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="amountToConfirm" type="xs:string"/>
     <xs:attribute name="amountToReserve" type="xs:string"/>
     <xs:attribute name="amountToCancel" type="xs:string"/>
     <xs:attribute name="accumulatedAmount" type="xs:string"/>
     <xs:attribute name="limit"  type="xs:decimal"/>
   </xs:complexType>
 </xs:element>

Constructor Summary
UpdateRateResult()
          Constructs an empty update session result.
 
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 objects, the child represents the marshallable object to be added into the content tree.
 void addStartRateResult(StartRateResult startRateResult)
           
 void addStopRateResult(StopRateResult stopRateResult)
           
 Money getAccumulatedAmount()
          Gets accumulated amount of the session.
 Money getAmountToCancel()
          Gets the amount to cancel.
 Money getAmountToConfirm()
          Gets the amount to confirm.
 Money getAmountToReserve()
          Gets the amount to reserve.
 java.math.BigDecimal getLimit()
          Gets the limit of the reservation in case of best effort one.
 java.lang.String getName()
           
 java.lang.String getOperandReference()
          Gets the code or the reference (if no code exists) identifying the operand of the operation.
 java.util.List<TransactionSet> getTransacSetsToCancel()
          Gets the list of transactions sets to cancel.
 java.util.List<TransactionSet> getTransacSetsToCleanup()
          Gets the list of transactions sets to cleanup.
 java.util.List<TransactionSet> getTransacSetsToConfirm()
          Gets the list of transactions sets to confirm.
 java.util.List<TransactionSet> getTransacSetsToReserve()
          Gets the list of transactions sets to reserve.
 void marshal(XMLOutputter output)
          Gives an XML representation of this object, and of its children.
 void setAccumulatedAmount(Money amount)
          Sets accumulated amount of the session.
 void setAmountToCancel(Money amount)
          Sets the amount to cancel.
 void setAmountToConfirm(Money amount)
          Sets the amount to confirm.
 void setAmountToReserve(Money amount)
          Sets the amount to reserve.
 void setAttributes(XMLAttributes atts)
          Sets the attributes of the XML representation of the tag beeing processed.
 void setLimit(java.math.BigDecimal limit)
          Sets the limit of the reservation in case of best effort one.
 void setOperandReference(java.lang.String operandReference)
          Sets the reference of the operand.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UpdateRateResult

public UpdateRateResult()
Constructs an empty update session result.

Method Detail

getOperandReference

public java.lang.String getOperandReference()
Description copied from interface: OperationResult
Gets the code or the reference (if no code exists) identifying the operand of the operation. If the operation is not auditable, the operand reference is null.

Specified by:
getOperandReference in interface OperationResult
Returns:
The operand reference of the result.

setOperandReference

public void setOperandReference(java.lang.String operandReference)
Sets the reference of the operand.

Parameters:
operandReference - the reference of the operand.

getName

public java.lang.String getName()

getAccumulatedAmount

public Money getAccumulatedAmount()
Gets accumulated amount of the session.

Returns:
the accumulated amount.

setAccumulatedAmount

public void setAccumulatedAmount(Money amount)
Sets accumulated amount of the session.

Parameters:
amount - the accumulated amount.

getLimit

public java.math.BigDecimal getLimit()
Gets the limit of the reservation in case of best effort one.

Returns:
the limit value.

setLimit

public void setLimit(java.math.BigDecimal limit)
Sets the limit of the reservation in case of best effort one.

Parameters:
limit - the limit value.

getTransacSetsToCleanup

public java.util.List<TransactionSet> getTransacSetsToCleanup()
Gets the list of transactions sets to cleanup.

Returns:
the list of transactions sets to cleanup.

getAmountToConfirm

public Money getAmountToConfirm()
Gets the amount to confirm.

Returns:
the amount to confirm.

setAmountToConfirm

public void setAmountToConfirm(Money amount)
Sets the amount to confirm.

Parameters:
amount - the amount to confirm.

getTransacSetsToConfirm

public java.util.List<TransactionSet> getTransacSetsToConfirm()
Gets the list of transactions sets to confirm.

Returns:
the list of transactions sets to confirm.

getAmountToReserve

public Money getAmountToReserve()
Gets the amount to reserve.

Returns:
the amount to reserve.

setAmountToReserve

public void setAmountToReserve(Money amount)
Sets the amount to reserve.

Parameters:
amount - the amount to reserve.

getTransacSetsToReserve

public java.util.List<TransactionSet> getTransacSetsToReserve()
Gets the list of transactions sets to reserve.

Returns:
the list of transactions sets to reserve.

getAmountToCancel

public Money getAmountToCancel()
Gets the amount to cancel.

Returns:
the amount to cancel.

setAmountToCancel

public void setAmountToCancel(Money amount)
Sets the amount to cancel.

Parameters:
amount - the amount to cancel.

getTransacSetsToCancel

public java.util.List<TransactionSet> getTransacSetsToCancel()
Gets the list of transactions sets to cancel.

Returns:
the list of transactions sets to cancel.

setAttributes

public void setAttributes(XMLAttributes atts)
Description copied from interface: XMLMarshallable
Sets the attributes of the XML representation of the tag beeing processed.

Specified by:
setAttributes in interface XMLMarshallable
Parameters:
atts - the XML attributes of the current tag.

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)
Description copied from interface: XMLMarshallable
Adds a child to the objects, the child represents the marshallable object to be added into the content tree.

Specified by:
addChild in interface XMLMarshallable
Parameters:
tagName - the name of tag for the child.
child - the child to be added.

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.

marshal

public void marshal(XMLOutputter output)
Description copied from interface: XMLMarshallable
Gives an XML representation of this object, and of its children.

Specified by:
marshal in interface XMLMarshallable
Parameters:
output - the XML output to marshall the object into.

addStopRateResult

public void addStopRateResult(StopRateResult stopRateResult)

addStartRateResult

public void addStartRateResult(StartRateResult startRateResult)

SAP CC 1.0
API 4.2 (Core)


API Reference - July 2009

SAP Convergent Charging 1.0 (build R4.2.1.35.0.0)
CONVERGENT CHARGING 4.2

(c) Copyright 2009 SAP AG. All rights reserved.