com.highdeal.pnr.hci

Class PnRObjectSet

java.lang.Object

com.highdeal.pnr.hci.PnRObjectSetList

com.highdeal.pnr.hci.PnRObjectSet

All Implemented Interfaces:

XMLMapping, XMLMarshallable

public class PnRObjectSet
extends PnRObjectSetList
implements XMLMarshallable, XMLMapping

This Java class represents a PnR object set; A PnR object set represents the transitive closure of a PnR object.

It contains:

• a list of offers
• a list of charge plans
• a list of reusable charge components
• a list of refill plans
• a list of refill logic objects
• a list of pricing macros
• a list of translation tables
• a list of tier tables
• a list of mapping tables
• a list of charged item classes
• a list of refill record classes
• a list of products
• a list of chargeable item classes
• a list of refill item classes
• a list of allowance event class
• a list of range table classes
• a list of range tables
• a list of charged item aggregation policies
• a list of monitoring plans
• a list of exportable item mapping objects
• a list of allowance interface
• a list of counter names dictionary
• a list of spending status description

Some of these object lists may be empty.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="pnrObjectSet">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="offer" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="chargePlan" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="chargeComponent" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="refillPlan" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="refillLogic" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="allowancePlan" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="allowanceLogic" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="pricingMacro" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="translationTable" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="tierTable" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="mappingTableClass" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="mappingTable" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="product" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="chargeableItemClass" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="refillItemClass" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="chargedItemClass" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="refillRecordClass" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="allowanceEventClass" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="chargedItemAggregationPolicy" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="monitoringPlan" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="exportableItemMapping" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="allowanceInterface" minOccurs="0" maxOccurs="1"/>
      <xs:element ref="counterNamesDictionary" minOccurs="0" maxOccurs="1"/>
      <xs:element ref="spendingStatusDescription" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="rangeTableClass" type="RangeTableClassType" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="rangeTable" type="RangeTableType" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>
 </xs:element>

Nested Class Summary

Nested classes/interfaces inherited from class com.highdeal.pnr.hci.PnRObjectSetList

PnRObjectSetList.ISortRenderer<T>

Constructor Summary

Constructors

Constructor and Description
PnRObjectSet() Builds an empty PnRObjectSet.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String name, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
List<ICatalogObject>	getAllObjects() Gets an unmodifiable list of all the objects contained in the PnR object set.
Vector<com.highdeal.allowance.allowanceeventclass.hci.AllowanceEventClassModel>	getAllowanceEventClasses() Gets the list of allowance event classes.
Vector<com.highdeal.allowance.allowanceinterface.hci.AllowanceInterfaceModel>	getAllowanceInterfaces() Gets the list of allowance interfaces.
Vector<com.highdeal.allowance.allowancelogic.hci.AllowanceLogicModel>	getAllowanceLogics() Gets the list of allowance logic objects.
Vector<com.highdeal.allowance.allowanceplan.hci.AllowancePlanModel>	getAllowancePlans() Gets the list of allowance plans.
Vector<com.highdeal.ciclass.hci.ChargeableItemClassModel>	getChargeableItemClasses() Gets the list of chargeable item classes.
Vector<ChargeComponentModel>	getChargeComponents() Gets the list of charge components.
Vector<com.highdeal.cit.aggregation.hci.ChargedItemAggregationPolicyModel>	getChargedItemAggregationPolicy() Gets the list of charged item aggregation policy objects.
Vector<ChargedItemClassModel>	getChargedItemClasses() Gets the list of charged item classes.
Vector<com.highdeal.chargeplan.hci.ChargePlanModel>	getChargePlans() Gets the list of charge plans.
Class<?>	getClass(String nsUri, String tag, XMLAttributes atts) Returns the Java class for a specified XML tag and its attributes in a namespace.
Vector<com.highdeal.dictionary.hci.CounterNamesDictionaryModel>	getCounterNamesDictionaries() Gets the list of counter name dictionaries.
Vector<ExportableItemMappingModel>	getExportableItemMappings() Gets the list of exportable item mapping objects.
Vector<MappingTableModel>	getMappingTable() Gets the list of mapping tables.
Vector<MappingTableClassModel>	getMappingTableClasses() Gets the list of mapping table classes.
Vector<com.highdeal.monitoringplan.hci.MonitoringPlanModel>	getMonitoringPlans() Gets the list of monitoring plans.
Vector<OfferModel>	getOffers() Gets the list of offers.
Vector<PricingMacroModel>	getPricingMacros() Gets the list of pricing macro objetcs.
Vector<ProductModel>	getProducts() Gets the list of products.
Vector<RangeTableClassModel>	getRangeTableClasses() Gets the list of range table classes.
Vector<RangeTableModel>	getRangeTables() Gets the list of range tables.
Vector<com.highdeal.refillitem.hci.RefillItemClassModel>	getRefillItemClasses() Gets the list of refill item classes.
Vector<com.highdeal.refilllogic.hci.RefillLogicModel>	getRefillLogics() Gets the list of refill logic objects.
Vector<com.highdeal.refillplan.hci.RefillPlanModel>	getRefillPlans() Gets the list of refill plans.
Vector<com.highdeal.refillrecord.hci.RefillRecordClassModel>	getRefillRecordClasses() Gets the list of refill record classes.
Vector<com.highdeal.spendingstatus.hci.SpendingStatusDescriptionModel>	getSpendingStatusDescriptions() Gets the list of spending status descriptions.
Vector<TierTableModel>	getTierTables() Gets the list of tier tables.
Vector<TranslationTableModel>	getTranslationTables() Gets the list of translation tables.
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.

Methods inherited from class com.highdeal.pnr.hci.PnRObjectSetList

add, addAllowanceEventClass, addAllowanceInterface, addAllowanceLogic, addAllowancePlan, addChargeableItemClass, addChargeComponent, addChargedItemAggregationPolicy, addChargedItemClass, addChargePlan, addCounterNamesDictionary, addExportableItemMapping, addMappingTable, addMappingTableClass, addMonitoringPlan, addOffer, addPricingMacro, addProduct, addRangeTable, addRangeTableClass, addRefillItemClass, addRefillLogic, addRefillPlan, addRefillRecordClass, addSpendingStatusDescription, addTierTable, addTranslationTable, sortPnRObjectSet

Methods inherited from class java.lang.Object

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

Constructor Detail

PnRObjectSet

public PnRObjectSet()

Builds an empty PnRObjectSet.

Method Detail

getOffers

public Vector<OfferModel> getOffers()

Gets the list of offers.

Returns:

A vector of offers

getChargePlans

public Vector<com.highdeal.chargeplan.hci.ChargePlanModel> getChargePlans()

Gets the list of charge plans.

Returns:

A vector of charge plans

getRefillPlans

public Vector<com.highdeal.refillplan.hci.RefillPlanModel> getRefillPlans()

Gets the list of refill plans.

Returns:

A vector of refill plans

getChargeComponents

public Vector<ChargeComponentModel> getChargeComponents()

Gets the list of charge components.

Returns:

A vector of reusable charge components

getRefillLogics

public Vector<com.highdeal.refilllogic.hci.RefillLogicModel> getRefillLogics()

Gets the list of refill logic objects.

Returns:

A vector of refill logic objects

getPricingMacros

public Vector<PricingMacroModel> getPricingMacros()

Gets the list of pricing macro objetcs.

Returns:

A vector of pricing macros

getTranslationTables

public Vector<TranslationTableModel> getTranslationTables()

Gets the list of translation tables.

Returns:

A vector of TranslationTable

getTierTables

public Vector<TierTableModel> getTierTables()

Gets the list of tier tables.

Returns:

A vector of tier tables

getMappingTableClasses

public Vector<MappingTableClassModel> getMappingTableClasses()

Gets the list of mapping table classes.

Returns:

A vector of mapping table classes

getMappingTable

public Vector<MappingTableModel> getMappingTable()

Gets the list of mapping tables.

Returns:

A vector of mapping tables

getProducts

public Vector<ProductModel> getProducts()

Gets the list of products.

Returns:

A vector of products

getChargeableItemClasses

public Vector<com.highdeal.ciclass.hci.ChargeableItemClassModel> getChargeableItemClasses()

Gets the list of chargeable item classes.

Returns:

A vector of chargeable item classes

getRefillItemClasses

public Vector<com.highdeal.refillitem.hci.RefillItemClassModel> getRefillItemClasses()

Gets the list of refill item classes.

Returns:

A vector of refill item classes

getChargedItemClasses

public Vector<ChargedItemClassModel> getChargedItemClasses()

Gets the list of charged item classes.

Returns:

A vector of charged item classes

getRefillRecordClasses

public Vector<com.highdeal.refillrecord.hci.RefillRecordClassModel> getRefillRecordClasses()

Gets the list of refill record classes.

Returns:

A vector of refill record classes

getAllowanceEventClasses

public Vector<com.highdeal.allowance.allowanceeventclass.hci.AllowanceEventClassModel> getAllowanceEventClasses()

Gets the list of allowance event classes.

Returns:

A vector of allowance event classes

getChargedItemAggregationPolicy

public Vector<com.highdeal.cit.aggregation.hci.ChargedItemAggregationPolicyModel> getChargedItemAggregationPolicy()

Gets the list of charged item aggregation policy objects.

Returns:

A vector of charged item aggregation policy objects

getRangeTableClasses

public Vector<RangeTableClassModel> getRangeTableClasses()

Gets the list of range table classes.

Returns:

A vector of range table classes

getRangeTables

public Vector<RangeTableModel> getRangeTables()

Gets the list of range tables.

Returns:

A vector of range tables

getMonitoringPlans

public Vector<com.highdeal.monitoringplan.hci.MonitoringPlanModel> getMonitoringPlans()

Gets the list of monitoring plans.

Returns:

A vector of monitoring plans

getExportableItemMappings

public Vector<ExportableItemMappingModel> getExportableItemMappings()

Gets the list of exportable item mapping objects.

Returns:

A vector of mapping objects

getAllowanceInterfaces

public Vector<com.highdeal.allowance.allowanceinterface.hci.AllowanceInterfaceModel> getAllowanceInterfaces()

Gets the list of allowance interfaces.

Returns:

A vector of allowance interfaces

getCounterNamesDictionaries

public Vector<com.highdeal.dictionary.hci.CounterNamesDictionaryModel> getCounterNamesDictionaries()

Gets the list of counter name dictionaries.

Returns:

A vector of counter name dictionaries

getAllowancePlans

public Vector<com.highdeal.allowance.allowanceplan.hci.AllowancePlanModel> getAllowancePlans()

Gets the list of allowance plans.

Returns:

A vector of allowance plans

getAllowanceLogics

public Vector<com.highdeal.allowance.allowancelogic.hci.AllowanceLogicModel> getAllowanceLogics()

Gets the list of allowance logic objects.

Returns:

A vector of allowance logic objects

getSpendingStatusDescriptions

public Vector<com.highdeal.spendingstatus.hci.SpendingStatusDescriptionModel> getSpendingStatusDescriptions()

Gets the list of spending status descriptions.

Returns:

A vector of spending status descriptions

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 name,
                     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:

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

getClass

public Class<?> getClass(String nsUri,
                         String tag,
                         XMLAttributes atts)

Description copied from interface: XMLMapping

Returns the Java class for a specified XML tag and its attributes in a namespace.

Specified by:

getClass in interface XMLMapping

Parameters:

nsUri - The unique resource identifier of the namespace of the XML tag

tag - The local part of the XML tag

atts - The attributes of the XML tag

Returns:

A Java class with a default constructor

getAllObjects

public List<ICatalogObject> getAllObjects()

Gets an unmodifiable list of all the objects contained in the PnR object set.

Returns:

An unmodifiable list of all the objects contained in the PnR object set