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

Interface VcsInformation

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface VcsInformation
extends GroupedAvp
    Defines an interface representing the VCS-Information grouped AVP type. From the Diameter Rf Reference Point Protocol Details (3GPP TS 32.299 V12.11.0) specification: 
     7.2.242 A    VCS-Information AVP
 
 The VCS-Information AVP (AVP code 3410) is of type Grouped. Its purpose is to allow the transmission of additional VCS service specific information elements. 
 It has the following ABNF grammar:
 
     VCS-Information ::=      < AVP Header: 3410>
                                 [ Bearer-Capability ]
                                 [ Network-Call-Reference-Number ]
                                 [ MSC-Address ]
                                 [ Basic-Service-Code ]
                                 [ ISUP-Location-Number ]
                                 [ VLR-Number ]
                                 [ Forwarding-Pending ]
                                 [ ISUP-Cause ]
                                 [ Start-Time ]
                                 [ Start-of-Charging ]
                                 [ Stop-Time ]
                                 [ PS-Free-Format-Data ]
    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

      • hasBearerCapability

        boolean hasBearerCapability()
        Returns true if the Bearer-Capability AVP is present in the VCS-Information AVP.

      • getBearerCapability

        byte[] getBearerCapability()
        Returns the value of the Bearer-Capability AVP, of type OctetString.
        Returns:
        the value of the Bearer-Capability AVP, or null if it has not been set.

      • setBearerCapability

        void setBearerCapability​(byte[] bearerCapability)
        Sets the value of the Bearer-Capability AVP, of type OctetString.
        Throws:
        NullPointerException - if bearerCapability is null.

      • removeBearerCapability

        void removeBearerCapability()
        Removes the Bearer-Capability AVP from the VCS-Information AVP. If the Bearer-Capability AVP is not present, this method returns silently.

      • hasNetworkCallReferenceNumber

        boolean hasNetworkCallReferenceNumber()
        Returns true if the Network-Call-Reference-Number AVP is present in the VCS-Information AVP.

      • getNetworkCallReferenceNumber

        byte[] getNetworkCallReferenceNumber()
        Returns the value of the Network-Call-Reference-Number AVP, of type OctetString.
        Returns:
        the value of the Network-Call-Reference-Number AVP, or null if it has not been set.

      • setNetworkCallReferenceNumber

        void setNetworkCallReferenceNumber​(byte[] networkCallReferenceNumber)
        Sets the value of the Network-Call-Reference-Number AVP, of type OctetString.
        Throws:
        NullPointerException - if networkCallReferenceNumber is null.

      • removeNetworkCallReferenceNumber

        void removeNetworkCallReferenceNumber()
        Removes the Network-Call-Reference-Number AVP from the VCS-Information AVP. If the Network-Call-Reference-Number AVP is not present, this method returns silently.

      • hasMscAddress

        boolean hasMscAddress()
        Returns true if the MSC-Address AVP is present in the VCS-Information AVP.

      • getMscAddress

        byte[] getMscAddress()
        Returns the value of the MSC-Address AVP, of type OctetString.
        Returns:
        the value of the MSC-Address AVP, or null if it has not been set.

      • setMscAddress

        void setMscAddress​(byte[] mscAddress)
        Sets the value of the MSC-Address AVP, of type OctetString.
        Throws:
        NullPointerException - if mscAddress is null.

      • removeMscAddress

        void removeMscAddress()
        Removes the MSC-Address AVP from the VCS-Information AVP. If the MSC-Address AVP is not present, this method returns silently.

      • hasBasicServiceCode

        boolean hasBasicServiceCode()
        Returns true if the Basic-Service-Code AVP is present in the VCS-Information AVP.

      • getBasicServiceCode

        BasicServiceCode getBasicServiceCode()
        Returns the value of the Basic-Service-Code AVP, of type Grouped.
        Returns:
        the value of the Basic-Service-Code AVP, or null if it has not been set.

      • setBasicServiceCode

        void setBasicServiceCode​(BasicServiceCode basicServiceCode)
        Sets the value of the Basic-Service-Code AVP, of type Grouped.
        Throws:
        NullPointerException - if basicServiceCode is null.

      • removeBasicServiceCode

        void removeBasicServiceCode()
        Removes the Basic-Service-Code AVP from the VCS-Information AVP. If the Basic-Service-Code AVP is not present, this method returns silently.

      • hasIsupLocationNumber

        boolean hasIsupLocationNumber()
        Returns true if the ISUP-Location-Number AVP is present in the VCS-Information AVP.

      • getIsupLocationNumber

        byte[] getIsupLocationNumber()
        Returns the value of the ISUP-Location-Number AVP, of type OctetString.
        Returns:
        the value of the ISUP-Location-Number AVP, or null if it has not been set.

      • setIsupLocationNumber

        void setIsupLocationNumber​(byte[] isupLocationNumber)
        Sets the value of the ISUP-Location-Number AVP, of type OctetString.
        Throws:
        NullPointerException - if isupLocationNumber is null.

      • removeIsupLocationNumber

        void removeIsupLocationNumber()
        Removes the ISUP-Location-Number AVP from the VCS-Information AVP. If the ISUP-Location-Number AVP is not present, this method returns silently.

      • hasVlrNumber

        boolean hasVlrNumber()
        Returns true if the VLR-Number AVP is present in the VCS-Information AVP.

      • getVlrNumber

        byte[] getVlrNumber()
        Returns the value of the VLR-Number AVP, of type OctetString.
        Returns:
        the value of the VLR-Number AVP, or null if it has not been set.

      • setVlrNumber

        void setVlrNumber​(byte[] vlrNumber)
        Sets the value of the VLR-Number AVP, of type OctetString.
        Throws:
        NullPointerException - if vlrNumber is null.

      • removeVlrNumber

        void removeVlrNumber()
        Removes the VLR-Number AVP from the VCS-Information AVP. If the VLR-Number AVP is not present, this method returns silently.

      • hasForwardingPending

        boolean hasForwardingPending()
        Returns true if the Forwarding-Pending AVP is present in the VCS-Information AVP.

      • getForwardingPending

        ForwardingPending getForwardingPending()
        Returns the value of the Forwarding-Pending AVP, of type Enumerated.
        Returns:
        the value of the Forwarding-Pending AVP, or null if it has not been set.

      • setForwardingPending

        void setForwardingPending​(ForwardingPending forwardingPending)
        Sets the value of the Forwarding-Pending AVP, of type Enumerated.
        Throws:
        NullPointerException - if forwardingPending is null.

      • removeForwardingPending

        void removeForwardingPending()
        Removes the Forwarding-Pending AVP from the VCS-Information AVP. If the Forwarding-Pending AVP is not present, this method returns silently.

      • hasIsupCause

        boolean hasIsupCause()
        Returns true if the ISUP-Cause AVP is present in the VCS-Information AVP.

      • getIsupCause

        IsupCause getIsupCause()
        Returns the value of the ISUP-Cause AVP, of type Grouped.
        Returns:
        the value of the ISUP-Cause AVP, or null if it has not been set.

      • setIsupCause

        void setIsupCause​(IsupCause isupCause)
        Sets the value of the ISUP-Cause AVP, of type Grouped.
        Throws:
        NullPointerException - if isupCause is null.

      • removeIsupCause

        void removeIsupCause()
        Removes the ISUP-Cause AVP from the VCS-Information AVP. If the ISUP-Cause AVP is not present, this method returns silently.

      • hasStartTime

        boolean hasStartTime()
        Returns true if the Start-Time AVP is present in the VCS-Information AVP.

      • getStartTime

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

      • setStartTime

        void setStartTime​(Date startTime)
        Sets the value of the Start-Time AVP, of type Time.
        Throws:
        NullPointerException - if startTime is null.

      • removeStartTime

        void removeStartTime()
        Removes the Start-Time AVP from the VCS-Information AVP. If the Start-Time AVP is not present, this method returns silently.

      • hasStartOfCharging

        boolean hasStartOfCharging()
        Returns true if the Start-of-Charging AVP is present in the VCS-Information AVP.

      • getStartOfCharging

        Date getStartOfCharging()
        Returns the value of the Start-of-Charging AVP, of type Time.
        Returns:
        the value of the Start-of-Charging AVP, or null if it has not been set.

      • setStartOfCharging

        void setStartOfCharging​(Date startOfCharging)
        Sets the value of the Start-of-Charging AVP, of type Time.
        Throws:
        NullPointerException - if startOfCharging is null.

      • removeStartOfCharging

        void removeStartOfCharging()
        Removes the Start-of-Charging AVP from the VCS-Information AVP. If the Start-of-Charging AVP is not present, this method returns silently.

      • hasStopTime

        boolean hasStopTime()
        Returns true if the Stop-Time AVP is present in the VCS-Information AVP.

      • getStopTime

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

      • setStopTime

        void setStopTime​(Date stopTime)
        Sets the value of the Stop-Time AVP, of type Time.
        Throws:
        NullPointerException - if stopTime is null.

      • removeStopTime

        void removeStopTime()
        Removes the Stop-Time AVP from the VCS-Information AVP. If the Stop-Time AVP is not present, this method returns silently.

      • hasPsFreeFormatData

        boolean hasPsFreeFormatData()
        Returns true if the PS-Free-Format-Data AVP is present in the VCS-Information AVP.

      • getPsFreeFormatData

        byte[] getPsFreeFormatData()
        Returns the value of the PS-Free-Format-Data AVP, of type OctetString.
        Returns:
        the value of the PS-Free-Format-Data AVP, or null if it has not been set.

      • setPsFreeFormatData

        void setPsFreeFormatData​(byte[] psFreeFormatData)
        Sets the value of the PS-Free-Format-Data AVP, of type OctetString.
        Throws:
        NullPointerException - if psFreeFormatData is null.

      • removePsFreeFormatData

        void removePsFreeFormatData()
        Removes the PS-Free-Format-Data AVP from the VCS-Information AVP. If the PS-Free-Format-Data 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 VCS-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 VCS-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 VCS-Information AVP. If no extension AVPs are present, this method returns silently.