Interface RadioParameterSetInfo

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp

    public interface RadioParameterSetInfo
    extends GroupedAvp
    Defines an interface representing the Radio-Parameter-Set-Info grouped AVP type. From the Diameter Ro Reference Point Protocol Details (3GPP TS 32.299 V12.11.0) specification:
     7.2.160 B    Radio-Parameter-Set-Info AVP
     
     The Radio-Parameter-Set-Info AVP (AVP code 3463) is of type Grouped and provides information on a radio parameter set configured in the UE for direct communication use. Each set has an associated time stamp of when it became active.
     It has the following ABNF grammar:
     
         Radio-Parameter-Set-Info ::= < AVP Header: 3463>
                                         [ Radio-Parameter-Set-Values ]
                                         [ Change-Time ]
     
    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

      • hasRadioParameterSetValues

        boolean hasRadioParameterSetValues()
        Returns true if the Radio-Parameter-Set-Values AVP is present in the Radio-Parameter-Set-Info AVP.
      • getRadioParameterSetValues

        byte[] getRadioParameterSetValues()
        Returns the value of the Radio-Parameter-Set-Values AVP, of type OctetString.
        Returns:
        the value of the Radio-Parameter-Set-Values AVP, or null if it has not been set.
      • setRadioParameterSetValues

        void setRadioParameterSetValues​(byte[] radioParameterSetValues)
        Sets the value of the Radio-Parameter-Set-Values AVP, of type OctetString.
        Throws:
        NullPointerException - if radioParameterSetValues is null.
      • removeRadioParameterSetValues

        void removeRadioParameterSetValues()
        Removes the Radio-Parameter-Set-Values AVP from the Radio-Parameter-Set-Info AVP. If the Radio-Parameter-Set-Values AVP is not present, this method returns silently.
      • hasChangeTime

        boolean hasChangeTime()
        Returns true if the Change-Time AVP is present in the Radio-Parameter-Set-Info AVP.
      • getChangeTime

        Date getChangeTime()
        Returns the value of the Change-Time AVP, of type Time.
        Returns:
        the value of the Change-Time AVP, or null if it has not been set.
      • setChangeTime

        void setChangeTime​(Date changeTime)
        Sets the value of the Change-Time AVP, of type Time.
        Throws:
        NullPointerException - if changeTime is null.
      • removeChangeTime

        void removeChangeTime()
        Removes the Change-Time AVP from the Radio-Parameter-Set-Info AVP. If the Change-Time 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 Radio-Parameter-Set-Info 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 Radio-Parameter-Set-Info 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 Radio-Parameter-Set-Info AVP. If no extension AVPs are present, this method returns silently.