Package com.highdeal.contract.hci

Class ChargingContractItemUserTechnicalIdentifierModel

java.lang.Object
com.highdeal.hci.HCIModelAdapter
com.highdeal.contract.hci.ChargingContractItemUserTechnicalIdentifierModel
All Implemented Interfaces:
ITagNameProvider, IXMLMarshallable, XMLMarshallable
public class ChargingContractItemUserTechnicalIdentifierModel extends HCIModelAdapter
A User Technical Identifier is a list of user identifiers that the Provisioning system provides in the Charging Contract Item in order to create technical Accesses.

Indeed, in order to use a service, an Access to that service must be created.
The Access is composed by a user identifier and a service identifier.
Multiple service identifiers are already known from the current object's representation in the Charge Plan Class.
Needed user identifiers are then provided by the current object in order to create Accesses.
At the end, all possibles combinations of service and user identifiers are built and so we have {number of service identifiers coming from the Charge Plan} x {number of user identifiers coming from the current object} = {number of created Accesses}.

A ChargingContractItemUserTechnicalIdentifierModel is composed of:

  • A name, which must be the same name as the one defined in the Charge Plan Class. It uniquely identifies a User Technical Identifier in a Charging Contract Item.
  • A list of user identifiers, which are used to create Accesses. This list cannot be empty and no checking is performed on values because Convergent Charging does not know what could be used or not. This is of the responsibility of the provisioning system to provide valid data.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:complexType name="ChargingContractItemUserTechnicalIdentifierType">
   <xs:attribute name="name" type="xs:string"/>
   <xs:attribute name="userServiceId" type="xs:string" />
 </xs:complexType>

  • Field Details

    • TAG_NAME

      public static final String TAG_NAME
      The XML tag name of the User Technical Identifier XML representation
      See Also:

  • Constructor Details

    • ChargingContractItemUserTechnicalIdentifierModel

      public ChargingContractItemUserTechnicalIdentifierModel()
      Default constructor of the Charging Contract Item User Technical Identifier

  • Method Details

    • getName

      public String getName()
      Gets the name which uniquely identifies the ChargingContractItemUserTechnicalIdentifierModel in the Charging Contract Item.
      Returns:
      the name which uniquely identifies the ChargingContractItemUserTechnicalIdentifierModel in the Charging Contract Item.

    • setName

      public void setName(String name)
      Sets the name which uniquely identifies the ChargingContractItemUserTechnicalIdentifierModel in the Charging Contract Item.
      Parameters:
      name - the name which uniquely identifies the ChargingContractItemUserTechnicalIdentifierModel in the Charging Contract Item.

    • getUserServiceIdentifier

      public String getUserServiceIdentifier()
      Gets the user service identifier of the ChargingContractItemUserTechnicalIdentifierModel which are used to create Accesses.
      Returns:
      the user service identifier of the ChargingContractItemUserTechnicalIdentifierModel which are used to create Accesses

    • setUserServiceIdentifier

      public void setUserServiceIdentifier(String userServiceId)
      Sets the user service identifier of the ChargingContractItemUserTechnicalIdentifierModel which are used to create Accesses.
      Parameters:
      userServiceId - the user service identifier of the ChargingContractItemUserTechnicalIdentifierModel which are used to create Accesses

    • getTagName

      public String getTagName()
      Description copied from interface: ITagNameProvider
      Gets the XML tag name of the HCI model.
      Returns:
      The XML tag name

    • setAttributes

      public void setAttributes(XMLAttributes atts)
      Description copied from interface: XMLMarshallable
      Sets the attributes of the XML representation of the element being processed.
      Parameters:
      atts - The XML attributes of the current element

    • marshalAttributes

      public void marshalAttributes(XMLOutputter output)
      Description copied from interface: IXMLMarshallable
      Gives an XML representation of the attributes of an object.
      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.
      Parameters:
      output - The XML output to marshal the child objects into

    • addCharacterData

      public void addCharacterData(String cData)
      Description copied from interface: XMLMarshallable
      Adds character data to the content element.
      Parameters:
      cData - The character data to be added

    • 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.
      Parameters:
      tagName - The name of tag for the child
      child - The child to be added