com.highdeal.pnr.hci

Class ChargeableItemDescriptionModel

java.lang.Object

com.highdeal.pnr.hci.ChargeableItemDescriptionModel

All Implemented Interfaces:

XMLMarshallable

public class ChargeableItemDescriptionModel
extends Object
implements XMLMarshallable

This Java class represents a chargeable item class the scheme of incoming chargeable items that is added to a Chargeable Item Package.

Concepts and Terminology

Since version 2.0, the functional concept is a chargeable item class. The SAP user configures this business object in the SAP CC Core Tool user interface when designing and configuring the pricing logic relevant for the pricing of customer service use (consumption, periodic fees, one off fees).

The technical concept in Java technology remains this ChargeableItemDescriptionModel class.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="item">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="prop" minOccurs="0" maxOccurs="unbounded"/>  <!-- custom properties -->
     </xs:sequence>
     <xs:attribute name="name" type="xs:string" use="required"/>
     <xs:attribute name="description" type="xs:string"/>
   </xs:complexType>
 </xs:element>

Constructor Summary

Constructors

Constructor and Description
ChargeableItemDescriptionModel() Builds an empty ChargeableItemDescriptionModel.
ChargeableItemDescriptionModel(String name, String description) Builds a ChargeableItemDescriptionModel.
ChargeableItemDescriptionModel(String name, String description, Vector<PropertyDescriptionModel> propertyDescList) Builds a ChargeableItemDescriptionModel.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String tagname, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
boolean	checkValidity() Tests if a name exists.
String	getDescription() Returns the comprehensive description of this chargeable item description.
String	getName() Returns the name of the chargeable item.
Vector<PropertyDescriptionModel>	getPropertyDescriptions() Returns the list of the user properties (custom properties) declared in the chargeable item description (chargeable item class).
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	setDescription(String desc) Sets a comprehensive description for this chargeable item description.
void	setName(String n) Sets the name of the chargeable item class (formerly chargeable item description).

Methods inherited from class java.lang.Object

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

Constructor Detail

ChargeableItemDescriptionModel

public ChargeableItemDescriptionModel()

Builds an empty ChargeableItemDescriptionModel.

ChargeableItemDescriptionModel

public ChargeableItemDescriptionModel(String name,
                                      String description)

Builds a ChargeableItemDescriptionModel.

Parameters:

name - The name of the chargeable item

description - A textual description for this chargeable item description

ChargeableItemDescriptionModel

public ChargeableItemDescriptionModel(String name,
                                      String description,
                                      Vector<PropertyDescriptionModel> propertyDescList)

Builds a ChargeableItemDescriptionModel.

Parameters:

name - The name of the description; it must be unique inside a product.

description - A textual description of the chargeable item description

propertyDescList - The list of associated PropertyDescriptionModel for the chargeable item description.

Method Detail

getDescription

public String getDescription()

Returns the comprehensive description of this chargeable item description.

Returns:

The text description of this chargeable item description

setDescription

public void setDescription(String desc)

Sets a comprehensive description for this chargeable item description.

Parameters:

desc - The text description of this chargeable item description

getName

public String getName()

Returns the name of the chargeable item.

Returns:

The name of the chargeable item

setName

public void setName(String n)

Sets the name of the chargeable item class (formerly chargeable item description).

Parameters:

n - The name of this chargeable item description

getPropertyDescriptions

public Vector<PropertyDescriptionModel> getPropertyDescriptions()

Returns the list of the user properties (custom properties) declared in the chargeable item description (chargeable item class).

Returns:

The list of the associated PropertyDescriptionModel

checkValidity

public boolean checkValidity()

Tests if a name exists.

Returns:

true if the name and property descriptions are valid; false otherwise

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(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(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