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

java.lang.Object
- com.highdeal.mappingtable.hci.CommonMappingTableModel

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, XMLMapping, XMLMarshallable

Direct Known Subclasses:

MappingTableModel, SubscriberMappingTableModel
```
public abstract class CommonMappingTableModel
extends java.lang.Object
implements IXMLMarshallable, ITagNameProvider, XMLMapping
```
This abstract Java class facilitates the handling of mapping tables and subscriber mapping tables in master data managed by the connected SAP CC Core Server system and stored in its back-end database system.
It defines the common structure of mapping tables and subscriber mapping tables: rows with input and output columns filled, reference of the mapping table class; additional information elements.
Note

Refer to the SAP CC Application Help in the SAP CC 5.0 product documentation for more information about:
- mapping tables and mapping table classes in master data (pricing catalog of the service provider)
- subscriber mapping tables in customer master data (information relating to the end customers of the service provider)
  
  Consult the Features, Master Data, and Processes and Functions sections.
See Also:

MappingTableModel, SubscriberMappingTableModel

XML API for HCI
The XML APIs specify the following XSD fragment:
XSD Fragment
```
<xs:complexType name="CommonMappingTable" abstract="true">
   <xs:sequence>
     <xs:element name="description" type="DescriptionType" minOccurs="0" maxOccurs="1" />
     <xs:element name="additionalInfo" type="AdditionalInfoType" minOccurs="0" maxOccurs="unbounded" />
 	   <xs:element name="mappingTableRow" type="MappingTableRow" minOccurs="0" maxOccurs="unbounded" />
   </xs:sequence>
   <xs:attribute name="id" type="xs:string" />
   <xs:attribute name="mappingTableClassId" type="xs:string" />
 </xs:complexType>
```

Constructor Summary

Constructors
Constructor and Description

CommonMappingTableModel()

Constructors
Constructor and Description
`CommonMappingTableModel()`

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.
`java.util.List<AdditionalInfoModel>`	`getAdditionalInfoList()` Gets the list of information dedicated to external system.
`java.lang.Class<?>`	`getClass(java.lang.String nsUri, java.lang.String tag, XMLAttributes atts)` Returns the `Java class` for a specified `XML tag` and its attributes in a namespace.
`java.lang.String`	`getDescription()` Gets the comprehensive description of the mapping table.
`java.lang.String`	`getId()` Gets the mapping table ID.
`java.lang.String`	`getMappingTableClassId()` Gets the code of the `mapping table class` used by this business data table.
`java.util.List<MappingTableRowModel>`	`getRows()` Gets the list of the rows contained into this table instance.
`void`	`marshal(XMLOutputter output)` Gives an XML representation of this object, including its children.
`void`	`marshalAttributes(XMLOutputter output)` Gives an XML representation of the attributes of an object.
`void`	`marshalChildren(XMLOutputter output)` Gives an XML representation of the child objects of an object.
`void`	`setAttributes(XMLAttributes atts)` Sets the attributes of the XML representation of the element being processed.
`void`	`setDescription(java.lang.String description)` Sets the comprehensive description of the mapping table.
`void`	`setId(java.lang.String id)` Sets the ID of the mapping table.
`void`	`setMappingTableClassId(java.lang.String mappingTableClassId)` Sets the mapping table class code that contains the table scheme.

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

Methods inherited from interface com.highdeal.hci.ITagNameProvider
getTagName

- Constructor Detail
  - CommonMappingTableModel
```
public CommonMappingTableModel()
```
- Method Detail
  - getId
```
public java.lang.String getId()
```
    Gets the mapping table ID.
    
    Returns:
    
    A string that contains the ID of the mapping table (or subscriber mapping table)
  - setId
```
public void setId(java.lang.String id)
```
    Sets the ID of the mapping table.
    
    Parameters:
    
    id - The identifier to set to the mapping table (or subscriber mapping table)
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the comprehensive description of the mapping table. Allow a better understanding about this mapping table.
    
    Returns:
    
    The text description of the mapping table
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Sets the comprehensive description of the mapping table. Allow a better understanding about this mapping table.
    
    Parameters:
    
    description - The text description of the mapping table
  - getMappingTableClassId
```
public java.lang.String getMappingTableClassId()
```
    Gets the code of the mapping table class used by this business data table.
    
    Returns:
    
    A string that contains the mapping table class ID to recover the scheme of the table
    
    See Also:
    
    MappingTableClassModel
  - setMappingTableClassId
```
public void setMappingTableClassId(java.lang.String mappingTableClassId)
```
    Sets the mapping table class code that contains the table scheme.
    
    Parameters:
    
    mappingTableClassId - The identifier of the mapping table class to use
  - getAdditionalInfoList
```
public java.util.List<AdditionalInfoModel> getAdditionalInfoList()
```
    Gets the list of information dedicated to external system. The designer of the mapping table adds information allowing an external system to search its specifics mapping table. An additional information is a property defined by its name and its value.
    
    Returns:
    
    The list of information dedicated to external system
  - getRows
```
public java.util.List<MappingTableRowModel> getRows()
```
    Gets the list of the rows contained into this table instance.
    
    Returns:
    
    A list containing mapping table row
    
    See Also:
    
    MappingTableRowModel
  - 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
  - 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
  - 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
  - marshalAttributes
```
public void marshalAttributes(XMLOutputter output)
```
    Description copied from interface: IXMLMarshallable
    
    Gives an XML representation of the attributes of an object.
    
    Specified by:
    
    marshalAttributes in interface IXMLMarshallable
    
    Parameters:
    
    output - The XML output to marshal the object attributes into
  - marshalChildren
```
public void marshalChildren(XMLOutputter output)
```
    Description copied from interface: IXMLMarshallable
    
    Gives an XML representation of the child objects of an object.
    
    Specified by:
    
    marshalChildren in interface IXMLMarshallable
    
    Parameters:
    
    output - The XML output to marshal the child objects into
  - 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 IXMLMarshallable
    
    Specified by:
    
    marshal in interface XMLMarshallable
    
    Parameters:
    
    output - The XML output to marshal the object into
  - getClass
```
public java.lang.Class<?> getClass(java.lang.String nsUri,
                                   java.lang.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

Class CommonMappingTableModel

XML API for HCI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.highdeal.hci.ITagNameProvider

Constructor Detail

CommonMappingTableModel

Method Detail

getId

setId

getDescription

setDescription

getMappingTableClassId

setMappingTableClassId

getAdditionalInfoList

getRows

addChild

setAttributes

addCharacterData

marshalAttributes

marshalChildren

marshal

getClass