com.highdeal.pnr.hci

Class ProductModel

java.lang.Object

com.highdeal.pnr.hci.ProductModel

All Implemented Interfaces:

XMLMarshallable, ICatalogObject

public class ProductModel
extends java.lang.Object
implements XMLMarshallable, ICatalogObject

This Java class represents a chargeable item package (aka product) - that corresponds to something that can be charged. In SAP Convergent Charging, the functional concept of product is revoked and replaced by the concept of chargeable item package.

Related Operation

• CreateProductOp
• SearchProductOp
• ModifyProductOp
• DeleteProductOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="product">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="item" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="description" type="xs:string"/>
     <xs:attribute name="code" type="xs:string" use="required"/>
     <xs:attribute name="reference" type="xs:string"/>
     <xs:attribute name="vendor" type="xs:string" use="required"/>
   </xs:complexType>
 </xs:element>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG_NAME

Constructor Summary

Constructors

Constructor and Description
ProductModel() Builds an empty product.
ProductModel(java.lang.String code, java.lang.String description) Builds a product from a code and a description.
ProductModel(java.lang.String code, java.lang.String description, java.lang.String p) Builds a product from a code, a description and a vendor.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChargeableItemDescription(ChargeableItemDescriptionModel cid) Adds a chargeable item description to the list which defines the product.
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.
boolean	checkValidity() Tests if the product is valid.
java.util.Vector<ChargeableItemDescriptionModel>	getChargeableItemDescriptions() Returns the list of chargeable item description which defines the product.
java.lang.String	getCode() Returns the code of the product.
java.lang.String	getDescription() Returns the description of the product.
java.lang.String	getOwner() Returns the catalog owner of the object.
java.lang.String	getReference() Returns the reference of the product.
java.lang.String	getVendor() Returns the vendor of the product.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	removeChargeableItemDescription(int index) Removes a chargeable item description from the list which defines the product.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setChargeableItemDescriptions(java.util.Vector<ChargeableItemDescriptionModel> descriptions) Sets the list of chargeable item description which defines the product.
void	setCode(java.lang.String code) Sets the code of the product.
void	setDescription(java.lang.String description) Sets the description of the product.
void	setReference(java.lang.String reference) Sets the reference of the product.
void	setVendor(java.lang.String v) Sets the vendor of the product.

Methods inherited from class java.lang.Object

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

Field Detail

TAG_NAME

public static final java.lang.String TAG_NAME

See Also:

Constant Field Values

Constructor Detail

ProductModel

public ProductModel()

Builds an empty product.

ProductModel

public ProductModel(java.lang.String code,
                    java.lang.String description)

Builds a product from a code and a description.

Parameters:

code - The code of the product

description - The description of the product

ProductModel

public ProductModel(java.lang.String code,
                    java.lang.String description,
                    java.lang.String p)

Builds a product from a code, a description and a vendor.

Parameters:

code - The code of the product

description - The description of the product

p - The vendor of the product

Method Detail

getReference

public java.lang.String getReference()

Returns the reference of the product.

Returns:

the reference of the product

setReference

public void setReference(java.lang.String reference)

Sets the reference of the product.

Parameters:

reference - The reference

getCode

public java.lang.String getCode()

Returns the code of the product.

Returns:

the code of the product

setCode

public void setCode(java.lang.String code)

Sets the code of the product.

Parameters:

code - The code of this product

getDescription

public java.lang.String getDescription()

Returns the description of the product.

Returns:

the description of the product

setDescription

public void setDescription(java.lang.String description)

Sets the description of the product.

Parameters:

description - the description of this product.

getChargeableItemDescriptions

public java.util.Vector<ChargeableItemDescriptionModel> getChargeableItemDescriptions()

Returns the list of chargeable item description which defines the product.

Returns:

a Vector of ChargeableItemDescriptionModel.

setChargeableItemDescriptions

public void setChargeableItemDescriptions(java.util.Vector<ChargeableItemDescriptionModel> descriptions)

Sets the list of chargeable item description which defines the product.

Parameters:

descriptions - A Vector of ChargeableItemDescriptionModel.

getOwner

public java.lang.String getOwner()

Description copied from interface: ICatalogObject

Returns the catalog owner of the object.

Specified by:

getOwner in interface ICatalogObject

Returns:

The catalog owner of the object

getVendor

public java.lang.String getVendor()

Returns the vendor of the product.

Returns:

the vendor of the product

setVendor

public void setVendor(java.lang.String v)

Sets the vendor of the product.

Parameters:

v - The vendor of the product

addChargeableItemDescription

public void addChargeableItemDescription(ChargeableItemDescriptionModel cid)

Adds a chargeable item description to the list which defines the product.

Parameters:

cid - The ChargeableItemDescriptionModel to add

removeChargeableItemDescription

public void removeChargeableItemDescription(int index)

Removes a chargeable item description from the list which defines the product.

Parameters:

index - The index of the chargeable item description to remove

checkValidity

public boolean checkValidity()

Tests if the product is valid. Product is valid if its name is not null or empty, and if all chargeable items are valid with unique names.

Returns:

true if the product is 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(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