Package org.jainslee.resources.diameter.gx.types.vcd0

Interface ChargingInformation

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface ChargingInformation
extends GroupedAvp
    Defines an interface representing the Charging-Information grouped AVP type. From the Diameter Gx Reference Point Protocol Details (3GPP TS 29.212 V11.9.0) specification: 
     6.3.19 Charging-Information
 
     The Charging-Information is of type Grouped, and contains the addresses of the charging functions.
 
     AVP format
 
     <Charging-Information> ::=  < AVP Header: 618 10415 >
                         [ Primary-Event-Charging-Function-Name ]
                         [ Secondary-Event-Charging-Function-Name ]
                         [ Primary-Charging-Collection-Function-Name ]
                         [ Secondary-Charging-Collection-Function-Name ]
                       * [ AVP ]
     From Cx and Dx interfaces based on the Diameter protocol (3GPP TS 29.229 V12.8.0 Release 12)

    • Method Detail

      • hasPrimaryEventChargingFunctionName

        boolean hasPrimaryEventChargingFunctionName()
        Returns true if the Primary-Event-Charging-Function-Name AVP is present in the Charging-Information AVP.

      • getPrimaryEventChargingFunctionName

        DiameterURI getPrimaryEventChargingFunctionName()
        Returns the value of the Primary-Event-Charging-Function-Name AVP, of type DiameterURI.
        Returns:
        the value of the Primary-Event-Charging-Function-Name AVP, or null if it has not been set.

      • setPrimaryEventChargingFunctionName

        void setPrimaryEventChargingFunctionName​(DiameterURI primaryEventChargingFunctionName)
        Sets the value of the Primary-Event-Charging-Function-Name AVP, of type DiameterURI.
        Throws:
        NullPointerException - if primaryEventChargingFunctionName is null.

      • removePrimaryEventChargingFunctionName

        void removePrimaryEventChargingFunctionName()
        Removes the Primary-Event-Charging-Function-Name AVP from the Charging-Information AVP. If the Primary-Event-Charging-Function-Name AVP is not present, this method returns silently.

      • hasSecondaryEventChargingFunctionName

        boolean hasSecondaryEventChargingFunctionName()
        Returns true if the Secondary-Event-Charging-Function-Name AVP is present in the Charging-Information AVP.

      • getSecondaryEventChargingFunctionName

        DiameterURI getSecondaryEventChargingFunctionName()
        Returns the value of the Secondary-Event-Charging-Function-Name AVP, of type DiameterURI.
        Returns:
        the value of the Secondary-Event-Charging-Function-Name AVP, or null if it has not been set.

      • setSecondaryEventChargingFunctionName

        void setSecondaryEventChargingFunctionName​(DiameterURI secondaryEventChargingFunctionName)
        Sets the value of the Secondary-Event-Charging-Function-Name AVP, of type DiameterURI.
        Throws:
        NullPointerException - if secondaryEventChargingFunctionName is null.

      • removeSecondaryEventChargingFunctionName

        void removeSecondaryEventChargingFunctionName()
        Removes the Secondary-Event-Charging-Function-Name AVP from the Charging-Information AVP. If the Secondary-Event-Charging-Function-Name AVP is not present, this method returns silently.

      • hasPrimaryChargingCollectionFunctionName

        boolean hasPrimaryChargingCollectionFunctionName()
        Returns true if the Primary-Charging-Collection-Function-Name AVP is present in the Charging-Information AVP.

      • getPrimaryChargingCollectionFunctionName

        DiameterURI getPrimaryChargingCollectionFunctionName()
        Returns the value of the Primary-Charging-Collection-Function-Name AVP, of type DiameterURI.
        Returns:
        the value of the Primary-Charging-Collection-Function-Name AVP, or null if it has not been set.

      • setPrimaryChargingCollectionFunctionName

        void setPrimaryChargingCollectionFunctionName​(DiameterURI primaryChargingCollectionFunctionName)
        Sets the value of the Primary-Charging-Collection-Function-Name AVP, of type DiameterURI.
        Throws:
        NullPointerException - if primaryChargingCollectionFunctionName is null.

      • removePrimaryChargingCollectionFunctionName

        void removePrimaryChargingCollectionFunctionName()
        Removes the Primary-Charging-Collection-Function-Name AVP from the Charging-Information AVP. If the Primary-Charging-Collection-Function-Name AVP is not present, this method returns silently.

      • hasSecondaryChargingCollectionFunctionName

        boolean hasSecondaryChargingCollectionFunctionName()
        Returns true if the Secondary-Charging-Collection-Function-Name AVP is present in the Charging-Information AVP.

      • getSecondaryChargingCollectionFunctionName

        DiameterURI getSecondaryChargingCollectionFunctionName()
        Returns the value of the Secondary-Charging-Collection-Function-Name AVP, of type DiameterURI.
        Returns:
        the value of the Secondary-Charging-Collection-Function-Name AVP, or null if it has not been set.

      • setSecondaryChargingCollectionFunctionName

        void setSecondaryChargingCollectionFunctionName​(DiameterURI secondaryChargingCollectionFunctionName)
        Sets the value of the Secondary-Charging-Collection-Function-Name AVP, of type DiameterURI.
        Throws:
        NullPointerException - if secondaryChargingCollectionFunctionName is null.

      • removeSecondaryChargingCollectionFunctionName

        void removeSecondaryChargingCollectionFunctionName()
        Removes the Secondary-Charging-Collection-Function-Name AVP from the Charging-Information AVP. If the Secondary-Charging-Collection-Function-Name AVP is not present, this method returns silently.

      • getExtensionAvps

        DiameterAvp[] getExtensionAvps()
        Returns the set of extension AVPs. The returned array contains the extension AVPs in the order they appear in the Charging-Information AVP. A return value of null implies that no extensions AVPs have been set.

      • setExtensionAvps

        void setExtensionAvps​(DiameterAvp[] avps)
               throws AvpNotAllowedException
        Sets the set of extension AVPs with all the values in the given array. The AVPs will be added to Charging-Information AVP in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getExtensionAvps() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        AvpNotAllowedException - if an AVP is encountered of a type already known to this class (i.e. an AVP for which get/set methods already appear in this class)
        NullPointerException - if avps is null.

      • removeExtensionAvps

        void removeExtensionAvps()
        Removes all extension AVPs from the Charging-Information AVP. If no extension AVPs are present, this method returns silently.