Package com.highdeal.rangetable.hci
Class RangeTableClassModel
java.lang.Object
com.highdeal.hci.HCIModelAdapter
com.highdeal.rangetable.hci.RangeTableClassModel
- All Implemented Interfaces:
ITagNameProvider,IXMLMarshallable,XMLMapping,XMLMarshallable,ICatalogObject
This
Java class represents a range table class that defines a table scheme;
It specifies the structure of a range table (or subscriber range table), with the number and the type of output columns.
This class is then referenced by the RangeTableModel to instantiate them.
Note
Refer to the SAP CC Application Help for more information about this business concept and master data.
Related Operations
- See Also:
XML API for HCI
The XML APIs specify the following XSD fragment:
XSD Fragment
<xs:complexType name="RangeTableClassType">
<xs:sequence>
<xs:element name="description" type="DescriptionType" minOccurs="1" maxOccurs="1" />
<xs:element name="additionalInfo" type="AdditionalInfoType" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="inColumn" type="InColumnType" minOccurs="0" maxOccurs="5"/>
<xs:element name="outColumn" type="OutColumnType" minOccurs="1" maxOccurs="15"/>
</xs:sequence>
<xs:attribute name="id" type="xs:string" />
<xs:attribute name="owner" type="xs:string" />
<xs:attribute name="rangeUpperBound" type="RangeBoundType" />
<xs:attribute name="lastRange" type="LastRangeType" />
</xs:complexType>
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumThisenumerationlists all the definitions for a range upper bound (bounded, unbounded).static enumThisenumerationlists all the out range table class attributes (inclusive, exclusive). -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe maximum number of in columns: 5static final intThe maximum number of out columns: 15static final StringThe XML tag name of this data model: "rangeTableClass" -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddCharacterData(String cData) Adds character data to the content element.voidaddChild(String tagName, XMLMarshallable child) Adds a child to the object, thechildrepresenting the marshallable object which must be added to the element.Gets the list of information dedicated to external system.Class<?>getClass(String nsUri, String tag, XMLAttributes atts) Returns theJava classfor a specifiedXML tagand its attributes in a namespace.Gets the range tabledescription.getId()Gets the range tableidentifier.Gets the input columns of the range table.Gets thelastRangetype of the range table.Gets the output columns of the range table.getOwner()Gets theownerof the range table.Gets therangeUpperBoundof the range table rows.Gets the XML tag of this HCI model.voidmarshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.voidmarshalChildren(XMLOutputter output) Gives an XML representation of the child objects of an object.voidsetAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.voidsetDescription(String description) Sets thedescriptionof the range table.voidSets the identifier of the range table.voidsetLastRange(RangeTableClassModel.LastRange lastRange) Sets thelastRangetype of the range table.voidSets theownerof the range table.voidsetRangeUpperBound(RangeTableClassModel.RangeBound rangeUpperBound) Sets therangeUpperBoundof the range table rows.Methods inherited from class com.highdeal.hci.HCIModelAdapter
marshal
-
Field Details
-
TAG_NAME
The XML tag name of this data model: "rangeTableClass"- See Also:
-
MAX_IN_COLUMN
public static final int MAX_IN_COLUMNThe maximum number of in columns: 5- See Also:
-
MAX_OUT_COLUMN
public static final int MAX_OUT_COLUMNThe maximum number of out columns: 15- See Also:
-
-
Constructor Details
-
RangeTableClassModel
public RangeTableClassModel()Default range table class constructor.
-
-
Method Details
-
getId
Gets the range tableidentifier.- Returns:
- A string that contains the
identifierof the range table
-
setId
Sets the identifier of the range table.- Parameters:
id- Theidentifierto set to this range table
-
getDescription
Gets the range tabledescription.- Returns:
- A string that contains the
descriptionof the range table
-
setDescription
Sets thedescriptionof the range table.- Parameters:
description- Thedescriptionto set to this range table
-
getOwner
Gets theownerof the range table.- Specified by:
getOwnerin interfaceICatalogObject- Returns:
- A string that contains the
ownerof the range table
-
setOwner
Sets theownerof the range table.- Parameters:
owner- Theownerto set to this range table
-
getRangeUpperBound
Gets therangeUpperBoundof the range table rows.- Returns:
- The rangeUpperBound of the range table rows
- See Also:
-
setRangeUpperBound
Sets therangeUpperBoundof the range table rows.- Parameters:
rangeUpperBound- TherangeUpperBoundof the range table rows- See Also:
-
getLastRange
Gets thelastRangetype of the range table.- Returns:
- The last range type of the range table
- See Also:
-
setLastRange
Sets thelastRangetype of the range table.- Parameters:
lastRange- TheLastRangeof the range table- See Also:
-
getInColumns
Gets the input columns of the range table.- Returns:
- A list that contains all the input columns
-
getOutColumns
Gets the output columns of the range table.- Returns:
- A list that contains all the output columns
-
getAdditionalInfoList
Gets the list of information dedicated to external system. The designer of the range table adds information allowing an external system tosearchits specific range tables. An additional information is a property defined by its name and its value.- Returns:
- The list of information dedicated to external system
-
getTagName
Gets the XML tag of this HCI model.- Specified by:
getTagNamein interfaceITagNameProvider- Returns:
- A string containing the XML tag of mapping table model
-
addCharacterData
Description copied from interface:XMLMarshallableAdds character data to the content element.- Specified by:
addCharacterDatain interfaceXMLMarshallable- Parameters:
cData- The character data to be added
-
addChild
Description copied from interface:XMLMarshallableAdds a child to the object, thechildrepresenting the marshallable object which must be added to the element.- Specified by:
addChildin interfaceXMLMarshallable- Parameters:
tagName- The name of tag for the childchild- The child to be added
-
setAttributes
Description copied from interface:XMLMarshallableSets the attributes of the XML representation of the element being processed.- Specified by:
setAttributesin interfaceXMLMarshallable- Parameters:
atts- TheXML attributesof the current element
-
marshalAttributes
Description copied from interface:IXMLMarshallableGives an XML representation of the attributes of an object.- Specified by:
marshalAttributesin interfaceIXMLMarshallable- Parameters:
output- TheXML outputto marshal the object attributes into
-
marshalChildren
Description copied from interface:IXMLMarshallableGives an XML representation of the child objects of an object.- Specified by:
marshalChildrenin interfaceIXMLMarshallable- Parameters:
output- TheXML outputto marshal the child objects into
-
getClass
Description copied from interface:XMLMappingReturns theJava classfor a specifiedXML tagand its attributes in a namespace.- Specified by:
getClassin interfaceXMLMapping- Parameters:
nsUri- The unique resource identifier of the namespace of the XML tagtag- The local part of the XML tagatts- The attributes of the XML tag- Returns:
- A
Java classwith a default constructor
-