com.highdeal.pnr.hci

Class StatelessRatingContext

java.lang.Object

com.highdeal.pnr.hci.StatelessRatingContext

All Implemented Interfaces:

XMLMarshallable

public class StatelessRatingContext
extends java.lang.Object
implements XMLMarshallable

This Java class represents the stateless rating context that must be speficied when your client application triggers a rating operation request (see the online charging services) in the connected SAP CC system.

Note

For more information about how to implement the sending of stateless rating operations, refer to the method:

StatelessServiceClient.statelessRate(java.lang.String, java.util.Date, com.highdeal.pnr.hci.StatelessRatingEvent, com.highdeal.pnr.hci.StatelessRatingContext, boolean, boolean)

Structure

If a stateless rating operation is performed on a multicurrency charge component, the stateless rating context must specify the currency which must be used during rating.
If a stateless rating operation is performed on a monocurrency charge component, the currency specified in the context is ignored.

Implementation in Your Client Application

You design and develop the management of rating contexts in your rating client: identification, storage, life cycle.

See Also:

StatelessServiceClient.statelessRate(java.lang.String, java.util.Date, com.highdeal.pnr.hci.StatelessRatingEvent, com.highdeal.pnr.hci.StatelessRatingContext, boolean, boolean)

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="statelessRatingContext">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="counter"
                   minOccurs="0"
                   maxOccurs="unbounded"/>
       <xs:element ref="parameter"
                   minOccurs="0"
                   maxOccurs="unbounded"/>
       <xs:element ref="tableInstance"
                   minOccurs="0"
                   maxOccurs="unbounded"/>
       <xs:element ref="tierTableInstance"
                   minOccurs="0"
                   maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="contextID" type="xs:string" use="optional"/>
     <xs:attribute name="effectiveDate" type="xs:dateTime" use="required"/>
     <xs:attribute name="lastRatingDate" type="xs:dateTime" use="optional"/>
     <xs:attribute name="currency" type="xs:string" use="optional"/>
   </xs:complexType>
 </xs:element>

Constructor Summary

Constructors

Constructor and Description
StatelessRatingContext()

Method Summary

Modifier and Type	Method and Description
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 object, the child representing the marshallable object which must be added to the element.
java.lang.String	getContextID() Returns the context identifier.
java.util.Vector<CounterModel>	getCounters() Gets the list of counters.
java.lang.String	getCurrencyCode() Gets the currency code.
java.util.Date	getEffectiveDate() Gets the effective date.
java.util.Date	getLastRatingDate() Gets the last rating date.
java.util.Vector<ParameterModel>	getParameters() Gets the list of parameters.
java.util.Vector<TierTableInstanceModel>	getTierTableInstances() Gets the list of TierTableInstanceModel.
java.util.Vector<TranslationInstanceModel>	getTranslationInstances() Gets the list of TranslationInstanceModel.
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	setContextID(java.lang.String contextID) Sets the context identifier; This ID is mainly for external use in the integration code.
void	setCurrencyCode(java.lang.String currencyCode) Sets the currency code.
void	setEffectiveDate(java.util.Date effectiveDate) Sets the effective date.
void	setLastRatingDate(java.util.Date lastRatingDate) Sets the last rating date.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatelessRatingContext

public StatelessRatingContext()

Method Detail

setContextID

public void setContextID(java.lang.String contextID)

Sets the context identifier; This ID is mainly for external use in the integration code.

Parameters:

contextID - The context ID

getContextID

public java.lang.String getContextID()

Returns the context identifier.

Returns:

The context ID

See Also:

setContextID(String)

getEffectiveDate

public java.util.Date getEffectiveDate()

Gets the effective date.

Returns:

The effective date value

setEffectiveDate

public void setEffectiveDate(java.util.Date effectiveDate)

Sets the effective date.

Parameters:

effectiveDate - The effective date value

getLastRatingDate

public java.util.Date getLastRatingDate()

Gets the last rating date.

Returns:

The last rating date value

setCurrencyCode

public void setCurrencyCode(java.lang.String currencyCode)

Sets the currency code.

Parameters:

currencyCode - The currency code value

getCurrencyCode

public java.lang.String getCurrencyCode()

Gets the currency code.

Returns:

The currency code value

setLastRatingDate

public void setLastRatingDate(java.util.Date lastRatingDate)

Sets the last rating date.

Parameters:

lastRatingDate - The last rating date value

getCounters

public java.util.Vector<CounterModel> getCounters()

Gets the list of counters.

Returns:

The list of counters

getParameters

public java.util.Vector<ParameterModel> getParameters()

Gets the list of parameters.

Returns:

The list of parameters

getTranslationInstances

public java.util.Vector<TranslationInstanceModel> getTranslationInstances()

Gets the list of TranslationInstanceModel.

Returns:

The list of TranslationInstanceModel

getTierTableInstances

public java.util.Vector<TierTableInstanceModel> getTierTableInstances()

Gets the list of TierTableInstanceModel.

Returns:

The list of TierTableInstanceModel

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

addChild

public void addChild(java.lang.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

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, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into