CatalogEntryModel (SAP CC 5.0 Java APIs (Core Library))

java.lang.Object
- com.highdeal.catalog.hci.CatalogEntryModel

All Implemented Interfaces:: XMLMarshallable

public class CatalogEntryModel
extends java.lang.Object
implements XMLMarshallable

This Java class represents a pricing catalog or an entry in a catalog in master data of a service provider; A catalog includes all the business objects that are necessary to configure the pricing logic of marketable services consumed by the end customers of the service provider.

A catalog entry includes a reference, an owner (service provider), a name, a type (directory or object), and a code. It can contain other catalog entries in a hierarchical way.

A pricing catalog is a directory entry.

Related Operations

Implementation in your Client Application

You can manage all the catalogs with the SAP CC Core Tool user interface. Consult the primary help of this user interface to know how to configure this master data and all the included data objects.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="catalogEntry">
   <xs:complexType>
     <xs:sequence>
         <xs:element ref="catalogEntry" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="owner" type="xs:string" use="required"/>
     <xs:attribute name="ref" type="xs:string"/>
     <xs:attribute name="name" type="xs:string"/>
     <xs:attribute name="type" type="CatalogEntryTypeType"/>
     <xs:attribute name="code" type="xs:string"/>
   </xs:complexType>
 </xs:element>

 <xs:simpleType name="CatalogEntryTypeType">
   <xs:union memberTypes="DirectoryEntryType ObjectType"/>
 </xs:simpleType>

 <xs:simpleType name="ObjectType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="product"/>
     <xs:enumeration value="chargeableItemClass"/>
     <xs:enumeration value="chargedItemClass"/>
     <xs:enumeration value="pricingMacro"/>
     <xs:enumeration value="translationTable"/>
     <xs:enumeration value="tierTable"/>
     <xs:enumeration value="mappingTableClass"/>
     <xs:enumeration value="mappingTable"/>
     <xs:enumeration value="rangeTableClass"/>
     <xs:enumeration value="rangeTable"/>
     <xs:enumeration value="offer"/>
     <xs:enumeration value="chargeComponent"/>
     <xs:enumeration value="chargePlan"/>
     <xs:enumeration value="refillItemClass"/>
     <xs:enumeration value="refillLogic"/>
     <xs:enumeration value="refillRecordClass"/>
     <xs:enumeration value="refillPlan"/>
     <xs:enumeration value="chargedItemAggregationPolicy"/>
     <xs:enumeration value="allowanceEventClass"/>
     <xs:enumeration value="allowanceLogic"/>
     <xs:enumeration value="allowancePlan"/>
     <xs:enumeration value="monitoringPlan"/>
   </xs:restriction>
 </xs:simpleType>

 <xs:simpleType name="DirectoryEntryType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="user_directory"/>  <!-- custom defined -->
     <xs:enumeration value="system_directory"/>
     <xs:enumeration value="root_directory"/>
   </xs:restriction>
 </xs:simpleType>

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ALLOWANCE_EVENT_CLASS_NODE`
`static java.lang.String`	`ALLOWANCE_LOGIC_NODE`
`static java.lang.String`	`ALLOWANCE_PLAN_NODE`
`static java.lang.String`	`CHARGE_COMPONENT_NODE` Java constant for a predefined catalog node that is dedicated to the reusable charges in price plan
`static java.lang.String`	`CHARGE_PLAN_NODE`
`static java.lang.String`	`CHARGEABLE_ITEM_CLASS_NODE`
`static java.lang.String`	`CHARGED_ITEM_AGGREGATION_POLICY_NODE`
`static java.lang.String`	`CHARGED_ITEM_CLASS_NODE`
`static java.lang.String`	`MAPPING_TABLE_CLASS_NODE`
`static java.lang.String`	`MAPPING_TABLE_NODE`
`static java.lang.String`	`MONITORING_PLAN_NODE`
`static java.lang.String`	`OFFER_NODE` Java constant for a predefined catalog node that is dedicated to the `offers` in master data of a service provider
`static java.lang.String`	`PRICING_MACRO_NODE`
`static java.lang.String`	`PRODUCT_NODE`
`static java.lang.String`	`RANGE_TABLE_CLASS_NODE`
`static java.lang.String`	`RANGE_TABLE_NODE`
`static java.lang.String`	`REFILL_COMPONENT_NODE`
`static java.lang.String`	`REFILL_ITEM_CLASS_NODE`
`static java.lang.String`	`REFILL_PLAN_NODE`
`static java.lang.String`	`REFILL_RECORD_CLASS_NODE`
`static java.lang.String`	`ROOT_DIRECTORY`
`static java.lang.String`	`SYSTEM_DIRECTORY`
`static java.lang.String`	`TIER_TABLE_NODE`
`static java.lang.String`	`TRANSLATION_TABLE_NODE`
`static java.lang.String`	`USER_DIRECTORY`

Constructor Summary

Constructors
Constructor and Description

CatalogEntryModel()
Builds an empty catalog entry.

Constructors
Constructor and Description
`CatalogEntryModel()` Builds an empty catalog entry.

Method Summary

All Methods Instance Methods Concrete Methods
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.
`CatalogEntryModel`	`getChildAt(int i)` Gets the child at a position.
`int`	`getChildCount()` Gets the child count.
`java.util.Vector<CatalogEntryModel>`	`getChildren()` Gets all the childrens.
`java.lang.String`	`getEntryCode()` Gets the entry code.
`java.lang.String`	`getEntryName()` Gets the entry name.
`java.lang.String`	`getEntryRef()` Returns the reference of the catalog entry.
`java.lang.String`	`getEntryType()` Gets the entry type.
`com.highdeal.pnr.hci.FirstClassObjectType`	`getFirstClassObjectType()` Gets the `first class object type` corresponding to the change list type.
`java.lang.String`	`getOwner()` Gets the owner (service provider) of the catalog entry.
`CatalogEntryModel`	`getParent()` Gets the parent entry of the current entry.
`void`	`insert(CatalogEntryModel entry, int i)` Inserts a child entry at a specified position.
`boolean`	`isLeaf()`
`void`	`marshal(XMLOutputter output)` Gives an XML representation of this object, including its children.
`void`	`remove(int i)` Removes a specified child entry.
`void`	`setAttributes(XMLAttributes atts)` Sets the attributes of the XML representation of the element being processed.
`void`	`setEntryCode(java.lang.String code)` Sets the entry code.
`void`	`setEntryName(java.lang.String name)` Sets the entry name.
`void`	`setEntryRef(java.lang.String ref)` Sets the entry reference.
`void`	`setEntryType(java.lang.String type)` Sets the entry type.
`void`	`setOwner(java.lang.String o)` Sets the owner of the catalog entry.
`void`	`setParent(CatalogEntryModel entry)` Sets the parent entry.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - USER_DIRECTORY
```
public static final java.lang.String USER_DIRECTORY
```
    See Also:
    
    Constant Field Values
  - SYSTEM_DIRECTORY
```
public static final java.lang.String SYSTEM_DIRECTORY
```
    See Also:
    
    Constant Field Values
  - ROOT_DIRECTORY
```
public static final java.lang.String ROOT_DIRECTORY
```
    See Also:
    
    Constant Field Values
  - CHARGED_ITEM_CLASS_NODE
```
public static final java.lang.String CHARGED_ITEM_CLASS_NODE
```
    See Also:
    
    Constant Field Values
  - REFILL_RECORD_CLASS_NODE
```
public static final java.lang.String REFILL_RECORD_CLASS_NODE
```
    See Also:
    
    Constant Field Values
  - CHARGE_COMPONENT_NODE
```
public static final java.lang.String CHARGE_COMPONENT_NODE
```
    Java constant for a predefined catalog node that is dedicated to the reusable charges in price plan
    
    See Also:
    
    Constant Field Values
  - OFFER_NODE
```
public static final java.lang.String OFFER_NODE
```
    Java constant for a predefined catalog node that is dedicated to the offers in master data of a service provider
    
    See Also:
    
    Constant Field Values
  - CHARGE_PLAN_NODE
```
public static final java.lang.String CHARGE_PLAN_NODE
```
    See Also:
    
    Constant Field Values
  - PRICING_MACRO_NODE
```
public static final java.lang.String PRICING_MACRO_NODE
```
    See Also:
    
    Constant Field Values
  - PRODUCT_NODE
```
public static final java.lang.String PRODUCT_NODE
```
    See Also:
    
    Constant Field Values
  - CHARGEABLE_ITEM_CLASS_NODE
```
public static final java.lang.String CHARGEABLE_ITEM_CLASS_NODE
```
    See Also:
    
    Constant Field Values
  - REFILL_ITEM_CLASS_NODE
```
public static final java.lang.String REFILL_ITEM_CLASS_NODE
```
    See Also:
    
    Constant Field Values
  - TRANSLATION_TABLE_NODE
```
public static final java.lang.String TRANSLATION_TABLE_NODE
```
    See Also:
    
    Constant Field Values
  - TIER_TABLE_NODE
```
public static final java.lang.String TIER_TABLE_NODE
```
    See Also:
    
    Constant Field Values
  - REFILL_COMPONENT_NODE
```
public static final java.lang.String REFILL_COMPONENT_NODE
```
    See Also:
    
    Constant Field Values
  - MAPPING_TABLE_CLASS_NODE
```
public static final java.lang.String MAPPING_TABLE_CLASS_NODE
```
    See Also:
    
    Constant Field Values
  - MAPPING_TABLE_NODE
```
public static final java.lang.String MAPPING_TABLE_NODE
```
    See Also:
    
    Constant Field Values
  - RANGE_TABLE_CLASS_NODE
```
public static final java.lang.String RANGE_TABLE_CLASS_NODE
```
    See Also:
    
    Constant Field Values
  - RANGE_TABLE_NODE
```
public static final java.lang.String RANGE_TABLE_NODE
```
    See Also:
    
    Constant Field Values
  - REFILL_PLAN_NODE
```
public static final java.lang.String REFILL_PLAN_NODE
```
    See Also:
    
    Constant Field Values
  - CHARGED_ITEM_AGGREGATION_POLICY_NODE
```
public static final java.lang.String CHARGED_ITEM_AGGREGATION_POLICY_NODE
```
    See Also:
    
    Constant Field Values
  - ALLOWANCE_PLAN_NODE
```
public static final java.lang.String ALLOWANCE_PLAN_NODE
```
    See Also:
    
    Constant Field Values
  - ALLOWANCE_LOGIC_NODE
```
public static final java.lang.String ALLOWANCE_LOGIC_NODE
```
    See Also:
    
    Constant Field Values
  - ALLOWANCE_EVENT_CLASS_NODE
```
public static final java.lang.String ALLOWANCE_EVENT_CLASS_NODE
```
    See Also:
    
    Constant Field Values
  - MONITORING_PLAN_NODE
```
public static final java.lang.String MONITORING_PLAN_NODE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CatalogEntryModel
```
public CatalogEntryModel()
```
    Builds an empty catalog entry.
- Method Detail
  - getEntryRef
```
public java.lang.String getEntryRef()
```
    Returns the reference of the catalog entry.
    
    Returns:
    
    The reference of the catalog entry
  - setEntryRef
```
public void setEntryRef(java.lang.String ref)
```
    Sets the entry reference.
    
    Parameters:
    
    ref - The entry reference
  - getOwner
```
public java.lang.String getOwner()
```
    Gets the owner (service provider) of the catalog entry.
    
    Returns:
    
    The owner of the catalog entry
  - setOwner
```
public void setOwner(java.lang.String o)
```
    Sets the owner of the catalog entry.
    
    Parameters:
    
    o - The owner of the catalog entry
  - getEntryName
```
public java.lang.String getEntryName()
```
    Gets the entry name.
    
    Returns:
    
    The entry name
  - setEntryName
```
public void setEntryName(java.lang.String name)
```
    Sets the entry name.
    
    Parameters:
    
    name - The entry name
  - getEntryType
```
public java.lang.String getEntryType()
```
    Gets the entry type.
    
    Returns:
    
    The entry type
  - setEntryType
```
public void setEntryType(java.lang.String type)
```
    Sets the entry type.
    
    Parameters:
    
    type - The entry type
  - getEntryCode
```
public java.lang.String getEntryCode()
```
    Gets the entry code.
    
    Returns:
    
    The entry code
  - setEntryCode
```
public void setEntryCode(java.lang.String code)
```
    Sets the entry code.
    
    Parameters:
    
    code - The entry code
  - getChildAt
```
public CatalogEntryModel getChildAt(int i)
```
    Gets the child at a position.
    
    Parameters:
    
    i - The child to be returned
    
    Returns:
    
    The child at the given position
  - getChildCount
```
public int getChildCount()
```
    Gets the child count.
    
    Returns:
    
    The child count
  - getChildren
```
public java.util.Vector<CatalogEntryModel> getChildren()
```
    Gets all the childrens.
    
    Returns:
    
    All childrens
  - getParent
```
public CatalogEntryModel getParent()
```
    Gets the parent entry of the current entry.
    
    Returns:
    
    The parent entry
  - setParent
```
public void setParent(CatalogEntryModel entry)
```
    Sets the parent entry.
    
    Parameters:
    
    entry - The parent entry
  - insert
```
public void insert(CatalogEntryModel entry,
                   int i)
```
    Inserts a child entry at a specified position.
    
    Parameters:
    
    entry - The catalog entry to insert
    
    i - The position at which to insert the entry
  - remove
```
public void remove(int i)
```
    Removes a specified child entry.
    
    Parameters:
    
    i - The index of the child to remove
  - isLeaf
```
public boolean isLeaf()
```
  - 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
  - getFirstClassObjectType
```
public com.highdeal.pnr.hci.FirstClassObjectType getFirstClassObjectType()
```
    Gets the first class object type corresponding to the change list type.
    
    Returns:
    
    the first class object type corresponding to the change list type

Class CatalogEntryModel

Related Operations

Implementation in your Client Application

XML API for HCI

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USER_DIRECTORY

SYSTEM_DIRECTORY

ROOT_DIRECTORY

CHARGED_ITEM_CLASS_NODE

REFILL_RECORD_CLASS_NODE

CHARGE_COMPONENT_NODE

OFFER_NODE

CHARGE_PLAN_NODE

PRICING_MACRO_NODE

PRODUCT_NODE

CHARGEABLE_ITEM_CLASS_NODE

REFILL_ITEM_CLASS_NODE

TRANSLATION_TABLE_NODE

TIER_TABLE_NODE

REFILL_COMPONENT_NODE

MAPPING_TABLE_CLASS_NODE

MAPPING_TABLE_NODE

RANGE_TABLE_CLASS_NODE

RANGE_TABLE_NODE

REFILL_PLAN_NODE

CHARGED_ITEM_AGGREGATION_POLICY_NODE

ALLOWANCE_PLAN_NODE

ALLOWANCE_LOGIC_NODE

ALLOWANCE_EVENT_CLASS_NODE

MONITORING_PLAN_NODE

Constructor Detail

CatalogEntryModel

Method Detail

getEntryRef

setEntryRef

getOwner

setOwner

getEntryName

setEntryName

getEntryType

setEntryType

getEntryCode

setEntryCode

getChildAt

getChildCount

getChildren

getParent

setParent

insert

remove

isLeaf

setAttributes

addChild

addCharacterData

marshal

getFirstClassObjectType