Package com.highdeal.contract.hci

Class ChargingContractItemRevisionModel

java.lang.Object
com.highdeal.hci.HCIModelAdapter
com.highdeal.contract.hci.ChargingContractItemRevisionModel
All Implemented Interfaces:
ITagNameProvider, IXMLMarshallable, XMLMapping, XMLMarshallable
public class ChargingContractItemRevisionModel extends HCIModelAdapter implements XMLMapping
A Charging Contract Item Revision

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="chargingContractItemRevision">
   <xs:complexType>
     <xs:sequence>
       <xs:choice>
         <xs:element ref="chargePlanClassId" />
         <xs:element ref="refillPlanClassId" />
         <xs:element ref="monitoringPlanClassId" />
       </xs:choice>
       <xs:element name="parameter" type="ChargingContractItemParameterType" minOccurs="0" maxOccurs="unbounded" />
       <xs:element name="sharedCounter" type="ChargingContractItemSharedCounterType" minOccurs="0" maxOccurs="unbounded" />
       <xs:element name="pooledCounter" type="ChargingContractItemPooledCounterType" minOccurs="0" maxOccurs="unbounded" />
       <xs:element name="userTechnicalIdentifier" type="ChargingContractItemUserTechnicalIdentifierType" minOccurs="0" maxOccurs="unbounded" />
       <xs:element name="accountAssignment" type="ChargingContractItemRevisionAccountAssignmentType" minOccurs="0" maxOccurs="unbounded" />
     </xs:sequence>
     <xs:attribute name="id" type="xs:string"/>
     <xs:attribute name="externalId" type="xs:string"/>
     <xs:attribute name="end" type="xs:dateTime"/>
   </xs:complexType>
 </xs:element>

  • Field Details

    • TAG_NAME

      public static final String TAG_NAME
      The XML tag name of the Charging Contract Item XML representation
      See Also:

  • Constructor Details

    • ChargingContractItemRevisionModel

      public ChargingContractItemRevisionModel()

  • Method Details

    • getId

      public String getId()
      Gets the identifier of the unique ChargingContractItemRevisionModel inside a ChargingContractModel.
      Returns:
      the identifier of the unique ChargingContractItemRevisionModel inside a ChargingContractModel

    • setId

      public void setId(String id)
      Sets the identifier of the unique ChargingContractItemRevisionModel inside a ChargingContractModel .
      Parameters:
      id - the identifier of the unique ChargingContractItemRevisionModel inside a ChargingContractModel

    • getExternalId

      public String getExternalId()
      Gets the external identifier of the ChargingContractItemRevisionModel inside a ChargingContractModel. The external identifier can be non unique within a ChargingContractItemRevisionModel.
      Returns:
      the external identifier of the ChargingContractItemRevisionModel

    • setExternalId

      public void setExternalId(String externalId)
      Sets the identifier of the unique ChargingContractItemRevisionModel inside a ChargingContractModel .
      Parameters:
      externalId - the identifier of the unique ChargingContractItemRevisionModel inside a ChargingContractModel

    • getChargePlanClassId

      public String getChargePlanClassId()
      Gets the identifier in the system Charge Plan Class that the Charging Contract Item Revision references.
      Returns:
      the identifier in the system Charge Plan Class that the Charging Contract Item Revision/tt> references

    • setChargePlanClassId

      public void setChargePlanClassId(String chargePlanClassId)
      Sets the identifier in the system Charge Plan Class that the Charging Contract Item Revision references.
      Parameters:
      chargePlanClassId - the identifier in the system Charge Plan Class that the Charging Contract Item Revision references

    • getRefillPlanClassId

      public String getRefillPlanClassId()
      Gets the identifier in the system Refill Plan Class that the Charging Contract Item Revision references.
      Returns:
      the identifier in the system Refill Plan Class that the Charging Contract Item Revision references

    • setRefillPlanClassId

      public void setRefillPlanClassId(String refillPlanClassId)
      Sets the identifier in the system Refill Plan Class that the Charging Contract Item Revision references.
      Parameters:
      refillPlanClassId - the identifier in the system Refill Plan Class that the Charging Contract Item Revision references

    • getMonitoringPlanClassId

      public String getMonitoringPlanClassId()
      Gets the identifier in the system Monitoring Plan Class that the Charging Contract Item Revision references.
      Returns:
      the identifier in the system Monitoring Plan Class that the Charging Contract Item Revision references

    • setMonitoringPlanClassId

      public void setMonitoringPlanClassId(String monitoringPlanClassId)
      Sets the identifier in the system Monitoring Plan Class that the Charging Contract Item Revision references.
      Parameters:
      monitoringPlanClassId - the identifier in the system Monitoring Plan Class that the Charging Contract Item Revision references

    • getEnd

      public Date getEnd()
      Gets the expiration date of the ChargingContractItemRevisionModel inside a ChargingContractModel.
      Returns:
      the expiration date of the ChargingContractItemRevisionModel inside a ChargingContractModel

    • setEnd

      public void setEnd(Date end)
      Sets the expiration date of the ChargingContractItemRevisionModel inside a ChargingContractModel .
      Parameters:
      end - the expiration date of the ChargingContractItemRevisionModel inside a ChargingContractModel

    • getChargingContractItemParameterList

      public List<ChargingContractItemParameterModel> getChargingContractItemParameterList()
      Gets the list where each Charge Plan Item Parameter redefines a parameter value of the Charge Component referenced.
      For a valid redefinition, the Charge Component parameter and the Charge Plan Item Parameter must have the same name and the same type.
      In this list, several Charge Plan Item Parameter mustn't have the same name.
      Returns:
      the list where each Charge Plan Item Parameter redefines a Charge Component parameter value of the Charge Component referenced.

    • getChargingContractItemSharedCounterList

      public List<ChargingContractItemSharedCounterModel> getChargingContractItemSharedCounterList()
      Gets the list where each Charging Contract Item Shared Counter redefines a Charge Plan Counter.
      For a valid redefinition, the Charge Plan counter and the Charging Contract Item Counter must have the same name.
      In this list, Charging Contract Item Counters must have unique names.
      Returns:
      the list where each Charging Contract Item Counter redefines a Charge Plan counter value.

    • getChargingContractItemPooledCounterList

      public List<ChargingContractItemPooledCounterModel> getChargingContractItemPooledCounterList()
      Gets the list where each Charging Contract Item Pooled Counter redefines a Charge Plan Counter.
      For a valid redefinition, the Charge Plan counter and the Charging Contract Item Counter must have the same name.
      In this list, Charging Contract Item Counters must have unique names.
      Returns:
      the list where each Charging Contract Item Counter redefines a Charge Plan counter value.

    • getChargingContractItemUserTechnicalIdentifierList

      public List<ChargingContractItemUserTechnicalIdentifierModel> getChargingContractItemUserTechnicalIdentifierList()
      Gets the list Charge Plan Item Account Assignment defined in the charging contract.
      Returns:
      the list of user technical data of the Charging Contract item.

    • getChargingContractItemAccountAssignmentList

      public List<ChargingContractItemRevisionAccountAssignmentModel> getChargingContractItemAccountAssignmentList()
      Gets the list Charge Plan Item Account Assignment defined in the charging contract.
      Returns:
      the list of account assignments of the Charging Contract item.

    • getTagName

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

    • 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

    • 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

    • 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

    • 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