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

Interface PresenceReportingAreaInformation

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface PresenceReportingAreaInformation
extends GroupedAvp
    Defines an interface representing the Presence-Reporting-Area-Information grouped AVP type. From the Diameter Rf Reference Point Protocol Details (3GPP TS 32.299 V12.11.0) specification: 
     5.3.109 Presence-Reporting-Area-Information AVP (3GPP-EPS access type)
 
 The Presence-Reporting-Area-Information AVP (AVP code 2822) is of type Grouped, contains the information which describes a Presence Reporting Area.
 The Presence-Reporting-Area-Identifier AVP defines a unique identifier for presence area.
 The Presence-Reporting-Area-Status AVP indicates the status of UE for presence reporting area.
 The Presence-Reporting-Area-Elements-List AVP contains, for a UE-dedicated presence area, the elements of the Presence Reporting Area. For a core network pre-configured presence reporting area, the element list shall not be present.
 When the presence area is UE-dedicated, the PCRF may acquire the presence reporting area information from the SPR.
 
 AVP Format:
 
     Presence-Reporting-Area-Information ::= < AVP Header: 2822 >
                              [ Presence-Reporting-Area-Identifier ]
                              [ Presence-Reporting-Area-Status ]
                              [ Presence-Reporting-Area-Elements-List ]
                             *[ AVP ]

    • Method Detail

      • hasPresenceReportingAreaIdentifier

        boolean hasPresenceReportingAreaIdentifier()
        Returns true if the Presence-Reporting-Area-Identifier AVP is present in the Presence-Reporting-Area-Information AVP.

      • getPresenceReportingAreaIdentifier

        byte[] getPresenceReportingAreaIdentifier()
        Returns the value of the Presence-Reporting-Area-Identifier AVP, of type OctetString.
        Returns:
        the value of the Presence-Reporting-Area-Identifier AVP, or null if it has not been set.

      • setPresenceReportingAreaIdentifier

        void setPresenceReportingAreaIdentifier​(byte[] presenceReportingAreaIdentifier)
        Sets the value of the Presence-Reporting-Area-Identifier AVP, of type OctetString.
        Throws:
        NullPointerException - if presenceReportingAreaIdentifier is null.

      • removePresenceReportingAreaIdentifier

        void removePresenceReportingAreaIdentifier()
        Removes the Presence-Reporting-Area-Identifier AVP from the Presence-Reporting-Area-Information AVP. If the Presence-Reporting-Area-Identifier AVP is not present, this method returns silently.

      • hasPresenceReportingAreaStatus

        boolean hasPresenceReportingAreaStatus()
        Returns true if the Presence-Reporting-Area-Status AVP is present in the Presence-Reporting-Area-Information AVP.

      • getPresenceReportingAreaStatus

        long getPresenceReportingAreaStatus()
        Returns the value of the Presence-Reporting-Area-Status AVP, of type Unsigned32. Use hasPresenceReportingAreaStatus() to check the existence of this AVP.
        Returns:
        the value of the Presence-Reporting-Area-Status AVP
        Throws:
        IllegalStateException - if the Presence-Reporting-Area-Status AVP has not been set.

      • setPresenceReportingAreaStatus

        void setPresenceReportingAreaStatus​(long presenceReportingAreaStatus)
        Sets the value of the Presence-Reporting-Area-Status AVP, of type Unsigned32.

      • removePresenceReportingAreaStatus

        void removePresenceReportingAreaStatus()
        Removes the Presence-Reporting-Area-Status AVP from the Presence-Reporting-Area-Information AVP. If the Presence-Reporting-Area-Status AVP is not present, this method returns silently.

      • hasPresenceReportingAreaElementsList

        boolean hasPresenceReportingAreaElementsList()
        Returns true if the Presence-Reporting-Area-Elements-List AVP is present in the Presence-Reporting-Area-Information AVP.

      • getPresenceReportingAreaElementsList

        byte[] getPresenceReportingAreaElementsList()
        Returns the value of the Presence-Reporting-Area-Elements-List AVP, of type OctetString.
        Returns:
        the value of the Presence-Reporting-Area-Elements-List AVP, or null if it has not been set.

      • setPresenceReportingAreaElementsList

        void setPresenceReportingAreaElementsList​(byte[] presenceReportingAreaElementsList)
        Sets the value of the Presence-Reporting-Area-Elements-List AVP, of type OctetString.
        Throws:
        NullPointerException - if presenceReportingAreaElementsList is null.

      • removePresenceReportingAreaElementsList

        void removePresenceReportingAreaElementsList()
        Removes the Presence-Reporting-Area-Elements-List AVP from the Presence-Reporting-Area-Information AVP. If the Presence-Reporting-Area-Elements-List 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 Presence-Reporting-Area-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 Presence-Reporting-Area-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 Presence-Reporting-Area-Information AVP. If no extension AVPs are present, this method returns silently.