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

Interface TalkBurstExchange

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface TalkBurstExchange
extends GroupedAvp
    Defines an interface representing the Talk-Burst-Exchange grouped AVP type. From the Diameter Rf Reference Point Protocol Details (3GPP TS 32.299 V10.0.0) specification: 
     7.2.220     Talk-Burst-Exchange AVP
 
 The Talk-Burst-Exchange AVP (AVP code 1255) is of type Grouped and holds the
 talk burst related charging data.
 
 It has the following ABNF grammar:
 
       Talk-Burst-Exchange ::=   < AVP Header: 1255 >
                                 { PoC-Change-Time }
                                 [ Number-Of-Talk-Bursts ]
                                 [ Talk-Burst-Volume ]
                                 [ Talk-Burst-Time ]
                                 [ Number-Of-Received-Talk-Bursts ]
                                 [ Received-Talk-Burst-Volume ]
                                 [ Received-Talk-Burst-Time ]
                                 [ Number-Of-Participants ]
                                 [ PoC-Change-Condition ]
    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

      • hasPocChangeTime

        boolean hasPocChangeTime()
        Returns true if the PoC-Change-Time AVP is present in the Talk-Burst-Exchange AVP.

      • getPocChangeTime

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

      • setPocChangeTime

        void setPocChangeTime​(Date pocChangeTime)
        Sets the value of the PoC-Change-Time AVP, of type Time.
        Throws:
        NullPointerException - if pocChangeTime is null.

      • removePocChangeTime

        void removePocChangeTime()
        Removes the PoC-Change-Time AVP from the Talk-Burst-Exchange AVP. If the PoC-Change-Time AVP is not present, this method returns silently.

      • hasNumberOfTalkBursts

        boolean hasNumberOfTalkBursts()
        Returns true if the Number-Of-Talk-Bursts AVP is present in the Talk-Burst-Exchange AVP.

      • getNumberOfTalkBursts

        long getNumberOfTalkBursts()
        Returns the value of the Number-Of-Talk-Bursts AVP, of type Unsigned32. Use hasNumberOfTalkBursts() to check the existence of this AVP.
        Returns:
        the value of the Number-Of-Talk-Bursts AVP
        Throws:
        IllegalStateException - if the Number-Of-Talk-Bursts AVP has not been set.

      • setNumberOfTalkBursts

        void setNumberOfTalkBursts​(long numberOfTalkBursts)
        Sets the value of the Number-Of-Talk-Bursts AVP, of type Unsigned32.

      • removeNumberOfTalkBursts

        void removeNumberOfTalkBursts()
        Removes the Number-Of-Talk-Bursts AVP from the Talk-Burst-Exchange AVP. If the Number-Of-Talk-Bursts AVP is not present, this method returns silently.

      • hasTalkBurstVolume

        boolean hasTalkBurstVolume()
        Returns true if the Talk-Burst-Volume AVP is present in the Talk-Burst-Exchange AVP.

      • getTalkBurstVolume

        long getTalkBurstVolume()
        Returns the value of the Talk-Burst-Volume AVP, of type Unsigned32. Use hasTalkBurstVolume() to check the existence of this AVP.
        Returns:
        the value of the Talk-Burst-Volume AVP
        Throws:
        IllegalStateException - if the Talk-Burst-Volume AVP has not been set.

      • setTalkBurstVolume

        void setTalkBurstVolume​(long talkBurstVolume)
        Sets the value of the Talk-Burst-Volume AVP, of type Unsigned32.

      • removeTalkBurstVolume

        void removeTalkBurstVolume()
        Removes the Talk-Burst-Volume AVP from the Talk-Burst-Exchange AVP. If the Talk-Burst-Volume AVP is not present, this method returns silently.

      • hasTalkBurstTime

        boolean hasTalkBurstTime()
        Returns true if the Talk-Burst-Time AVP is present in the Talk-Burst-Exchange AVP.

      • getTalkBurstTime

        long getTalkBurstTime()
        Returns the value of the Talk-Burst-Time AVP, of type Unsigned32. Use hasTalkBurstTime() to check the existence of this AVP.
        Returns:
        the value of the Talk-Burst-Time AVP
        Throws:
        IllegalStateException - if the Talk-Burst-Time AVP has not been set.

      • setTalkBurstTime

        void setTalkBurstTime​(long talkBurstTime)
        Sets the value of the Talk-Burst-Time AVP, of type Unsigned32.

      • removeTalkBurstTime

        void removeTalkBurstTime()
        Removes the Talk-Burst-Time AVP from the Talk-Burst-Exchange AVP. If the Talk-Burst-Time AVP is not present, this method returns silently.

      • hasNumberOfReceivedTalkBursts

        boolean hasNumberOfReceivedTalkBursts()
        Returns true if the Number-Of-Received-Talk-Bursts AVP is present in the Talk-Burst-Exchange AVP.

      • getNumberOfReceivedTalkBursts

        long getNumberOfReceivedTalkBursts()
        Returns the value of the Number-Of-Received-Talk-Bursts AVP, of type Unsigned32. Use hasNumberOfReceivedTalkBursts() to check the existence of this AVP.
        Returns:
        the value of the Number-Of-Received-Talk-Bursts AVP
        Throws:
        IllegalStateException - if the Number-Of-Received-Talk-Bursts AVP has not been set.

      • setNumberOfReceivedTalkBursts

        void setNumberOfReceivedTalkBursts​(long numberOfReceivedTalkBursts)
        Sets the value of the Number-Of-Received-Talk-Bursts AVP, of type Unsigned32.

      • removeNumberOfReceivedTalkBursts

        void removeNumberOfReceivedTalkBursts()
        Removes the Number-Of-Received-Talk-Bursts AVP from the Talk-Burst-Exchange AVP. If the Number-Of-Received-Talk-Bursts AVP is not present, this method returns silently.

      • hasReceivedTalkBurstVolume

        boolean hasReceivedTalkBurstVolume()
        Returns true if the Received-Talk-Burst-Volume AVP is present in the Talk-Burst-Exchange AVP.

      • getReceivedTalkBurstVolume

        long getReceivedTalkBurstVolume()
        Returns the value of the Received-Talk-Burst-Volume AVP, of type Unsigned32. Use hasReceivedTalkBurstVolume() to check the existence of this AVP.
        Returns:
        the value of the Received-Talk-Burst-Volume AVP
        Throws:
        IllegalStateException - if the Received-Talk-Burst-Volume AVP has not been set.

      • setReceivedTalkBurstVolume

        void setReceivedTalkBurstVolume​(long receivedTalkBurstVolume)
        Sets the value of the Received-Talk-Burst-Volume AVP, of type Unsigned32.

      • removeReceivedTalkBurstVolume

        void removeReceivedTalkBurstVolume()
        Removes the Received-Talk-Burst-Volume AVP from the Talk-Burst-Exchange AVP. If the Received-Talk-Burst-Volume AVP is not present, this method returns silently.

      • hasReceivedTalkBurstTime

        boolean hasReceivedTalkBurstTime()
        Returns true if the Received-Talk-Burst-Time AVP is present in the Talk-Burst-Exchange AVP.

      • getReceivedTalkBurstTime

        long getReceivedTalkBurstTime()
        Returns the value of the Received-Talk-Burst-Time AVP, of type Unsigned32. Use hasReceivedTalkBurstTime() to check the existence of this AVP.
        Returns:
        the value of the Received-Talk-Burst-Time AVP
        Throws:
        IllegalStateException - if the Received-Talk-Burst-Time AVP has not been set.

      • setReceivedTalkBurstTime

        void setReceivedTalkBurstTime​(long receivedTalkBurstTime)
        Sets the value of the Received-Talk-Burst-Time AVP, of type Unsigned32.

      • removeReceivedTalkBurstTime

        void removeReceivedTalkBurstTime()
        Removes the Received-Talk-Burst-Time AVP from the Talk-Burst-Exchange AVP. If the Received-Talk-Burst-Time AVP is not present, this method returns silently.

      • hasNumberOfParticipants

        boolean hasNumberOfParticipants()
        Returns true if the Number-Of-Participants AVP is present in the Talk-Burst-Exchange AVP.

      • getNumberOfParticipants

        long getNumberOfParticipants()
        Returns the value of the Number-Of-Participants AVP, of type Unsigned32. Use hasNumberOfParticipants() to check the existence of this AVP.
        Returns:
        the value of the Number-Of-Participants AVP
        Throws:
        IllegalStateException - if the Number-Of-Participants AVP has not been set.

      • setNumberOfParticipants

        void setNumberOfParticipants​(long numberOfParticipants)
        Sets the value of the Number-Of-Participants AVP, of type Unsigned32.

      • removeNumberOfParticipants

        void removeNumberOfParticipants()
        Removes the Number-Of-Participants AVP from the Talk-Burst-Exchange AVP. If the Number-Of-Participants AVP is not present, this method returns silently.

      • hasPocChangeCondition

        boolean hasPocChangeCondition()
        Returns true if the PoC-Change-Condition AVP is present in the Talk-Burst-Exchange AVP.

      • getPocChangeCondition

        PocChangeCondition getPocChangeCondition()
        Returns the value of the PoC-Change-Condition AVP, of type Enumerated.
        Returns:
        the value of the PoC-Change-Condition AVP, or null if it has not been set.

      • setPocChangeCondition

        void setPocChangeCondition​(PocChangeCondition pocChangeCondition)
        Sets the value of the PoC-Change-Condition AVP, of type Enumerated.
        Throws:
        NullPointerException - if pocChangeCondition is null.

      • removePocChangeCondition

        void removePocChangeCondition()
        Removes the PoC-Change-Condition AVP from the Talk-Burst-Exchange AVP. If the PoC-Change-Condition 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 Talk-Burst-Exchange 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 Talk-Burst-Exchange 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 Talk-Burst-Exchange AVP. If no extension AVPs are present, this method returns silently.