Package com.highdeal.rangetable.hci

Class CommonRangeTableRevisionModel

java.lang.Object
com.highdeal.rangetable.hci.CommonRangeTableRevisionModel
All Implemented Interfaces:
IXMLMarshallable, XMLMapping, XMLMarshallable
Direct Known Subclasses:
RangeTableRevisionModel, SubscriberRangeTableRevisionModel
public abstract class CommonRangeTableRevisionModel extends Object implements IXMLMarshallable, XMLMapping
This abstract Java class defines an abstract revision (period-based version) of a (subscriber) range table; You use the known subclasses with the create and modify operations.

It contains rows with input and output columns or range sets with a range set key and ranges.

The range table class ID is:

  • Optional for the modification
  • Mandatory for the creation

See Also:

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:complexType name="CommonRangeTableRevisionType" 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:choice>
       <xs:element name="rangeTableRow" type="RangeTableRowType" minOccurs="1" maxOccurs="unbounded" />
       <xs:element name="rangeSet" type="RangeTableRangeSetType" minOccurs="1" maxOccurs="unbounded"/>
     </xs:choice>
   </xs:sequence>
   <xs:attribute name="id" type="xs:string" />
   <xs:attribute name="rangeTableClassId" type="xs:string" use="optional" />
 </xs:complexType>

  • Constructor Details

    • CommonRangeTableRevisionModel

      public CommonRangeTableRevisionModel()

  • Method Details

    • getId

      public String getId()
      Gets the ID of the range table (or subscriber range table).
      Returns:
      A string that contains the identifier of the table

    • setId

      public void setId(String id)
      Sets the ID of the range table (or subscriber range table).
      Parameters:
      id - The identifier to set to the table

    • getRangeTableClassId

      public String getRangeTableClassId()
      Gets the range table class code used by this instance.
      Returns:
      A string that contains the range table class identifier to recover the scheme of the table
      See Also:

    • setRangeTableClassId

      public void setRangeTableClassId(String rangeTableClassId)
      Sets the range table class code that contains the table scheme.
      Parameters:
      rangeTableClassId - The identifier of the range table class to use

    • getDescription

      public String getDescription()
      Gets the description of the range table (or subscriber range table); Allow a better understanding about this range table.
      Returns:
      The description of the table

    • setDescription

      public void setDescription(String description)
      Sets the description of the range table (or subscriber range table); Allow a better understanding about this range table.
      Parameters:
      description - The description of the table

    • getAdditionalInfoList

      public List<AdditionalInfoModel> getAdditionalInfoList()
      Gets the list of information dedicated to external system. The designer of the Range Table adds information allowing an external system to search its specifics Range Table. An additional information is a property defined by its name and its value.
      Returns:
      The list of information dedicated to external system

    • setAdditionalInfoList

      public void setAdditionalInfoList(List<AdditionalInfoModel> additionalInfoList)
      Sets the list of information dedicated to external system. The designer of the Range Table adds information allowing an external system to search its specifics Range Table. An additional information is a property defined by its name and its value.
      Parameters:
      additionalInfoList - The list of information dedicated to external system

    • getRangeTableRowList

      public List<RangeTableRowModel> getRangeTableRowList()
      Gets the list of rows defined in the range table (or subscriber range table).
      Returns:
      The list of rows

    • setRangeTableRowList

      public void setRangeTableRowList(List<RangeTableRowModel> rangeTableRowList)
      Sets the list of rows defined in the range table (or subscriber range table).
      Parameters:
      rangeTableRowList - The list of rows

    • getRangeTableRangeSetList

      public List<RangeTableRangeSetModel> getRangeTableRangeSetList()
      Gets the list of range sets defined in the range table (or subscriber range table).
      Returns:
      The list of range sets

    • 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

    • 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(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

    • 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