SAP CC 1.0
API 4.2 (Core)

com.highdeal.pnr.hci
Class ChargeableItem

java.lang.Object
  extended by com.highdeal.pnr.hci.ChargeableItem
All Implemented Interfaces:
XMLMarshallable

public class ChargeableItem
extends java.lang.Object
implements XMLMarshallable

This class represents the chargeable item that is sent by client applications to perform the charge process.

See Also:
Property
XML Schema Fragment
<xs:element name="ci">
   <xs:complexType>
    <xs:sequence>
      <xs:element ref="p" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="n" type="xs:string"/>
   </xs:complexType>
  </xs:element>

Constructor Summary
ChargeableItem()
          Constructs an empty chargeable item.
ChargeableItem(java.lang.String name)
          Constructs a chargeable item with an action name.
ChargeableItem(java.lang.String name, java.util.Vector<Property> properties)
          Constructs a completly defined chargeable item.
 
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 addProperty(Property property)
          Adds a new property to this chargeable item.
 ChargeableItem duplicate()
          Returns a new clone instance of this chargeable item.
 java.lang.String getName()
          Returns the name of the chargeable item.
 java.util.Vector<Property> getProperties()
          Returns the vector of the item properties.
 Property getProperty(java.lang.String propertyName)
          Returns the property which name is propertyName.
 void marshal(XMLOutputter output)
          Gives an XML representation of this object, and of its children.
 void marshal(XMLOutputter output, java.lang.String tagName)
           
 void readFromCache(com.highdeal.cache.CacheInput ci)
           
 void setAttributes(XMLAttributes atts)
          Sets the attributes of the XML representation of the tag beeing processed.
 void setName(java.lang.String name)
          Sets the name of this chargeable item.
 void writeInCache(com.highdeal.cache.CacheOutput co)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChargeableItem

public ChargeableItem()
Constructs an empty chargeable item.


ChargeableItem

public ChargeableItem(java.lang.String name)
Constructs a chargeable item with an action name.

Parameters:
name - the name of the chargeable item.

ChargeableItem

public ChargeableItem(java.lang.String name,
                      java.util.Vector<Property> properties)
Constructs a completly defined chargeable item.

Parameters:
name - the name of the chargeable item.
properties - the property set associated to this Chargeable item.
Method Detail

setName

public void setName(java.lang.String name)
Sets the name of this chargeable item.

Parameters:
name - the name of the chargeable item.

getName

public java.lang.String getName()
Returns the name of the chargeable item.

Returns:
the name of the chargeable item.

addProperty

public void addProperty(Property property)
Adds a new property to this chargeable item.

Parameters:
property - the added property.

getProperties

public java.util.Vector<Property> getProperties()
Returns the vector of the item properties.

Returns:
a vector of properties

getProperty

public Property getProperty(java.lang.String propertyName)
Returns the property which name is propertyName.

Parameters:
propertyName - the name of the requested property.
Returns:
the requested property, or null if no such property exists in this chargeable item.

duplicate

public ChargeableItem duplicate()
Returns a new clone instance of this chargeable item.

Returns:
a new instance of this ChargeableItem.

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.

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.

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.

marshal

public void marshal(XMLOutputter output,
                    java.lang.String tagName)

writeInCache

public void writeInCache(com.highdeal.cache.CacheOutput co)

readFromCache

public void readFromCache(com.highdeal.cache.CacheInput ci)

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.