Package org.jainslee.resources.diameter.ro.types.v960

Interface AocService

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface AocService
extends GroupedAvp
    Defines an interface representing the AoC-Service grouped AVP type. From the Diameter Ro Reference Point Protocol Details (3GPP TS 32.299 V9.6.0) specification: 
     7.2.17  AoC-Service AVP
 The AoC-Service AVP (AVP code 2311) is of type Grouped and holds the pair of AoC Service type and AoC Service obligatory type.
 It has the following ABNF grammar:
 
     AoC-Service  ::=  < AVP Header: 2311 >
               [ AoC-Service-Obligatory-Type ]
                   [ AoC-Service-Type ]
    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

      • hasAocServiceObligatoryType

        boolean hasAocServiceObligatoryType()
        Returns true if the AoC-Service-Obligatory-Type AVP is present in the AoC-Service AVP.

      • getAocServiceObligatoryType

        AocServiceObligatoryType getAocServiceObligatoryType()
        Returns the value of the AoC-Service-Obligatory-Type AVP, of type Enumerated.
        Returns:
        the value of the AoC-Service-Obligatory-Type AVP, or null if it has not been set.

      • setAocServiceObligatoryType

        void setAocServiceObligatoryType​(AocServiceObligatoryType aocServiceObligatoryType)
        Sets the value of the AoC-Service-Obligatory-Type AVP, of type Enumerated.
        Throws:
        NullPointerException - if aocServiceObligatoryType is null.

      • removeAocServiceObligatoryType

        void removeAocServiceObligatoryType()
        Removes the AoC-Service-Obligatory-Type AVP from the AoC-Service AVP. If the AoC-Service-Obligatory-Type AVP is not present, this method returns silently.

      • hasAocServiceType

        boolean hasAocServiceType()
        Returns true if the AoC-Service-Type AVP is present in the AoC-Service AVP.

      • getAocServiceType

        AocServiceType getAocServiceType()
        Returns the value of the AoC-Service-Type AVP, of type Enumerated.
        Returns:
        the value of the AoC-Service-Type AVP, or null if it has not been set.

      • setAocServiceType

        void setAocServiceType​(AocServiceType aocServiceType)
        Sets the value of the AoC-Service-Type AVP, of type Enumerated.
        Throws:
        NullPointerException - if aocServiceType is null.

      • removeAocServiceType

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