Package org.jainslee.resources.diameter.rf.types.vcb0

Interface AocInformation

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface AocInformation
extends GroupedAvp
    Defines an interface representing the AoC-Information grouped AVP type. From the Diameter Rf Reference Point Protocol Details (3GPP TS 32.299 V12.11.0) specification: 
     7.2.15    AoC-Information AVP
 
 The AoC-Information AVP (AVP code 2054) is of type Grouped that includes the information required for advice of charge.
 It has the following ABNF grammar:
 
     AoC-Information ::=  < AVP Header: 2054 >
                          [ AoC-Cost-Information ]
                          [ Tariff-Information ]
    Note:
    The support for extension AVPs is present even thou the ABNF grammar for this AVP does not contain the "* [ AVP ]" line. Be aware that adding any extension AVPs may result in interoperability problems with products that strongly validate the incoming diameter message for it's adherence to the specification.

    • Method Detail

      • hasAocCostInformation

        boolean hasAocCostInformation()
        Returns true if the AoC-Cost-Information AVP is present in the AoC-Information AVP.

      • getAocCostInformation

        AocCostInformation getAocCostInformation()
        Returns the value of the AoC-Cost-Information AVP, of type Grouped.
        Returns:
        the value of the AoC-Cost-Information AVP, or null if it has not been set.

      • setAocCostInformation

        void setAocCostInformation​(AocCostInformation aocCostInformation)
        Sets the value of the AoC-Cost-Information AVP, of type Grouped.
        Throws:
        NullPointerException - if aocCostInformation is null.

      • removeAocCostInformation

        void removeAocCostInformation()
        Removes the AoC-Cost-Information AVP from the AoC-Information AVP. If the AoC-Cost-Information AVP is not present, this method returns silently.

      • hasTariffInformation

        boolean hasTariffInformation()
        Returns true if the Tariff-Information AVP is present in the AoC-Information AVP.

      • getTariffInformation

        TariffInformation getTariffInformation()
        Returns the value of the Tariff-Information AVP, of type Grouped.
        Returns:
        the value of the Tariff-Information AVP, or null if it has not been set.

      • setTariffInformation

        void setTariffInformation​(TariffInformation tariffInformation)
        Sets the value of the Tariff-Information AVP, of type Grouped.
        Throws:
        NullPointerException - if tariffInformation is null.

      • removeTariffInformation

        void removeTariffInformation()
        Removes the Tariff-Information AVP from the AoC-Information AVP. If the Tariff-Information 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 AoC-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 AoC-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 AoC-Information AVP. If no extension AVPs are present, this method returns silently.