Package com.highdeal.pnr.hci

Class AdditionalInfoModel

java.lang.Object

com.highdeal.pnr.hci.AdditionalInfo

com.highdeal.pnr.hci.AdditionalInfoModel

All Implemented Interfaces:

IXMLMarshallable, XMLMarshallable

public class AdditionalInfoModel
extends AdditionalInfo
implements IXMLMarshallable

This Java class represents an additional information that you can marshal; You use this typical object to customize information in your data. The AdditionalInfoModel is composed of:

• A name which identifies an unique additional information inside the data object.
• A description allowing a better understanding about the presence of this additional information inside the data object.
• A value (string, date, or number)

Note

You can add additional information to many data objects managed by SAP CC. For example, you can add such elements to the subscriptions in customer master data owned by a service provider.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="additionalInformation">
  <xs:complexType>
    <xs:attribute name="name" type="xs:string" use="required"/>
    <xs:attribute name="type" type="TypeTypeAI" default="string"/>
    <xs:attribute name="value" type="xs:string" use="required"/>
  </xs:complexType>
</xs:element>

 <xs:simpleType name="TypeTypeAI">
   <xs:restriction base="xs:string">
     <xs:enumeration value="string"/>
     <xs:enumeration value="number"/>
     <xs:enumeration value="date"/>
  </xs:restriction>
</xs:simpleType>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MODEL_NAME	The XML tag name of this data model: "additionalInformation"

Constructor Summary

Constructors

Constructor	Description
AdditionalInfoModel()	Builds an empty additional information.
AdditionalInfoModel(String name, int type, Object value)	Builds an additional information.

Method Summary

Modifier and Type	Method	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.
AdditionalInfoModel	duplicate()
void	marshal(XMLOutputter output)	Deprecated.
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.

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

checkValidity, equals, getName, getType, getValue, setName, setType, setValue

Methods inherited from class java.lang.Object

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

Field Details

MODEL_NAME

public static final String MODEL_NAME

The XML tag name of this data model: "additionalInformation"

See Also:

• Constant Field Values

Constructor Details

AdditionalInfoModel

public AdditionalInfoModel()

Builds an empty additional information.

AdditionalInfoModel

public AdditionalInfoModel(String name,
 int type,
 Object value)

Builds an additional information.

Parameters:

name - The name of the additional information

type - The type of the additional information

value - The value of the additional information

Method Details

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

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

@Deprecated
public void marshal(XMLOutputter output)

Deprecated.

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

duplicate

public AdditionalInfoModel duplicate()