Interface MdtConfiguration

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp

    public interface MdtConfiguration
    extends GroupedAvp
    Defines an interface representing the MDT-Configuration grouped AVP type. From the Diameter Gx Reference Point Protocol Details (3GPP TS 29.212 V11.9.0) specification:
     7.3.136 MDT-Configuration
     
         The MDT-Configuration AVP is of type Grouped. It shall contain MDT related information as specified in 3GPP TS 32.422 [23].
     
         The AVP format shall conform to:
     
                 MDT-Configuration ::= <AVP Header: 1622 10415>
                                         { Job-Type } 
                                         [ Area-Scope ] 
                                         [ List-Of-Measurements ] 
                                         [ Reporting-Trigger ]
                                         [ Report-Interval ] 
                                         [ Report-Amount ]
                                         [ Event-Threshold-RSRP ]
                                         [ Event-Threshold-RSRQ ]
                                         [ Logging-Interval ]
                                         [ Logging-Duration ]
                                         [ Measurement-Period-LTE ]
                                         [ Measurement-Period-UMTS ]
                                         [ Collection-Period-RRM-LTE ]
                                         [ Collection-Period-RRM-UMTS ]
                                         [ Positioning-Method ]
                                         [ Measurement-Quantity] 
                                         [ Event-Threshold-Event-1F ]
                                         [ Event-Threshold-Event-1I ]
                                        *[ MDT-Allowed-PLMN-Id ]
                                        *[ AVP ]
         From Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol (3GPP TS 29.272 V12.10.0)
     
     
     
    • Method Detail

      • hasJobType

        boolean hasJobType()
        Returns true if the Job-Type AVP is present in the MDT-Configuration AVP.
      • getJobType

        JobType getJobType()
        Returns the value of the Job-Type AVP, of type Enumerated.
        Returns:
        the value of the Job-Type AVP, or null if it has not been set.
      • setJobType

        void setJobType​(JobType jobType)
        Sets the value of the Job-Type AVP, of type Enumerated.
        Throws:
        NullPointerException - if jobType is null.
      • removeJobType

        void removeJobType()
        Removes the Job-Type AVP from the MDT-Configuration AVP. If the Job-Type AVP is not present, this method returns silently.
      • hasAreaScope

        boolean hasAreaScope()
        Returns true if the Area-Scope AVP is present in the MDT-Configuration AVP.
      • getAreaScope

        AreaScope getAreaScope()
        Returns the value of the Area-Scope AVP, of type Grouped.
        Returns:
        the value of the Area-Scope AVP, or null if it has not been set.
      • setAreaScope

        void setAreaScope​(AreaScope areaScope)
        Sets the value of the Area-Scope AVP, of type Grouped.
        Throws:
        NullPointerException - if areaScope is null.
      • removeAreaScope

        void removeAreaScope()
        Removes the Area-Scope AVP from the MDT-Configuration AVP. If the Area-Scope AVP is not present, this method returns silently.
      • hasListOfMeasurements

        boolean hasListOfMeasurements()
        Returns true if the List-Of-Measurements AVP is present in the MDT-Configuration AVP.
      • getListOfMeasurements

        long getListOfMeasurements()
        Returns the value of the List-Of-Measurements AVP, of type Unsigned32. Use hasListOfMeasurements() to check the existence of this AVP.
        Returns:
        the value of the List-Of-Measurements AVP
        Throws:
        IllegalStateException - if the List-Of-Measurements AVP has not been set.
      • setListOfMeasurements

        void setListOfMeasurements​(long listOfMeasurements)
        Sets the value of the List-Of-Measurements AVP, of type Unsigned32.
      • removeListOfMeasurements

        void removeListOfMeasurements()
        Removes the List-Of-Measurements AVP from the MDT-Configuration AVP. If the List-Of-Measurements AVP is not present, this method returns silently.
      • hasReportingTrigger

        boolean hasReportingTrigger()
        Returns true if the Reporting-Trigger AVP is present in the MDT-Configuration AVP.
      • getReportingTrigger

        long getReportingTrigger()
        Returns the value of the Reporting-Trigger AVP, of type Unsigned32. Use hasReportingTrigger() to check the existence of this AVP.
        Returns:
        the value of the Reporting-Trigger AVP
        Throws:
        IllegalStateException - if the Reporting-Trigger AVP has not been set.
      • setReportingTrigger

        void setReportingTrigger​(long reportingTrigger)
        Sets the value of the Reporting-Trigger AVP, of type Unsigned32.
      • removeReportingTrigger

        void removeReportingTrigger()
        Removes the Reporting-Trigger AVP from the MDT-Configuration AVP. If the Reporting-Trigger AVP is not present, this method returns silently.
      • hasReportInterval

        boolean hasReportInterval()
        Returns true if the Report-Interval AVP is present in the MDT-Configuration AVP.
      • getReportInterval

        ReportInterval getReportInterval()
        Returns the value of the Report-Interval AVP, of type Enumerated.
        Returns:
        the value of the Report-Interval AVP, or null if it has not been set.
      • setReportInterval

        void setReportInterval​(ReportInterval reportInterval)
        Sets the value of the Report-Interval AVP, of type Enumerated.
        Throws:
        NullPointerException - if reportInterval is null.
      • removeReportInterval

        void removeReportInterval()
        Removes the Report-Interval AVP from the MDT-Configuration AVP. If the Report-Interval AVP is not present, this method returns silently.
      • hasReportAmount

        boolean hasReportAmount()
        Returns true if the Report-Amount AVP is present in the MDT-Configuration AVP.
      • getReportAmount

        ReportAmount getReportAmount()
        Returns the value of the Report-Amount AVP, of type Enumerated.
        Returns:
        the value of the Report-Amount AVP, or null if it has not been set.
      • setReportAmount

        void setReportAmount​(ReportAmount reportAmount)
        Sets the value of the Report-Amount AVP, of type Enumerated.
        Throws:
        NullPointerException - if reportAmount is null.
      • removeReportAmount

        void removeReportAmount()
        Removes the Report-Amount AVP from the MDT-Configuration AVP. If the Report-Amount AVP is not present, this method returns silently.
      • hasEventThresholdRsrp

        boolean hasEventThresholdRsrp()
        Returns true if the Event-Threshold-RSRP AVP is present in the MDT-Configuration AVP.
      • getEventThresholdRsrp

        long getEventThresholdRsrp()
        Returns the value of the Event-Threshold-RSRP AVP, of type Unsigned32. Use hasEventThresholdRsrp() to check the existence of this AVP.
        Returns:
        the value of the Event-Threshold-RSRP AVP
        Throws:
        IllegalStateException - if the Event-Threshold-RSRP AVP has not been set.
      • setEventThresholdRsrp

        void setEventThresholdRsrp​(long eventThresholdRsrp)
        Sets the value of the Event-Threshold-RSRP AVP, of type Unsigned32.
      • removeEventThresholdRsrp

        void removeEventThresholdRsrp()
        Removes the Event-Threshold-RSRP AVP from the MDT-Configuration AVP. If the Event-Threshold-RSRP AVP is not present, this method returns silently.
      • hasEventThresholdRsrq

        boolean hasEventThresholdRsrq()
        Returns true if the Event-Threshold-RSRQ AVP is present in the MDT-Configuration AVP.
      • getEventThresholdRsrq

        long getEventThresholdRsrq()
        Returns the value of the Event-Threshold-RSRQ AVP, of type Unsigned32. Use hasEventThresholdRsrq() to check the existence of this AVP.
        Returns:
        the value of the Event-Threshold-RSRQ AVP
        Throws:
        IllegalStateException - if the Event-Threshold-RSRQ AVP has not been set.
      • setEventThresholdRsrq

        void setEventThresholdRsrq​(long eventThresholdRsrq)
        Sets the value of the Event-Threshold-RSRQ AVP, of type Unsigned32.
      • removeEventThresholdRsrq

        void removeEventThresholdRsrq()
        Removes the Event-Threshold-RSRQ AVP from the MDT-Configuration AVP. If the Event-Threshold-RSRQ AVP is not present, this method returns silently.
      • hasLoggingInterval

        boolean hasLoggingInterval()
        Returns true if the Logging-Interval AVP is present in the MDT-Configuration AVP.
      • getLoggingInterval

        LoggingInterval getLoggingInterval()
        Returns the value of the Logging-Interval AVP, of type Enumerated.
        Returns:
        the value of the Logging-Interval AVP, or null if it has not been set.
      • setLoggingInterval

        void setLoggingInterval​(LoggingInterval loggingInterval)
        Sets the value of the Logging-Interval AVP, of type Enumerated.
        Throws:
        NullPointerException - if loggingInterval is null.
      • removeLoggingInterval

        void removeLoggingInterval()
        Removes the Logging-Interval AVP from the MDT-Configuration AVP. If the Logging-Interval AVP is not present, this method returns silently.
      • hasLoggingDuration

        boolean hasLoggingDuration()
        Returns true if the Logging-Duration AVP is present in the MDT-Configuration AVP.
      • getLoggingDuration

        LoggingDuration getLoggingDuration()
        Returns the value of the Logging-Duration AVP, of type Enumerated.
        Returns:
        the value of the Logging-Duration AVP, or null if it has not been set.
      • setLoggingDuration

        void setLoggingDuration​(LoggingDuration loggingDuration)
        Sets the value of the Logging-Duration AVP, of type Enumerated.
        Throws:
        NullPointerException - if loggingDuration is null.
      • removeLoggingDuration

        void removeLoggingDuration()
        Removes the Logging-Duration AVP from the MDT-Configuration AVP. If the Logging-Duration AVP is not present, this method returns silently.
      • hasMeasurementPeriodLte

        boolean hasMeasurementPeriodLte()
        Returns true if the Measurement-Period-LTE AVP is present in the MDT-Configuration AVP.
      • getMeasurementPeriodLte

        MeasurementPeriodLte getMeasurementPeriodLte()
        Returns the value of the Measurement-Period-LTE AVP, of type Enumerated.
        Returns:
        the value of the Measurement-Period-LTE AVP, or null if it has not been set.
      • setMeasurementPeriodLte

        void setMeasurementPeriodLte​(MeasurementPeriodLte measurementPeriodLte)
        Sets the value of the Measurement-Period-LTE AVP, of type Enumerated.
        Throws:
        NullPointerException - if measurementPeriodLte is null.
      • removeMeasurementPeriodLte

        void removeMeasurementPeriodLte()
        Removes the Measurement-Period-LTE AVP from the MDT-Configuration AVP. If the Measurement-Period-LTE AVP is not present, this method returns silently.
      • hasMeasurementPeriodUmts

        boolean hasMeasurementPeriodUmts()
        Returns true if the Measurement-Period-UMTS AVP is present in the MDT-Configuration AVP.
      • getMeasurementPeriodUmts

        MeasurementPeriodUmts getMeasurementPeriodUmts()
        Returns the value of the Measurement-Period-UMTS AVP, of type Enumerated.
        Returns:
        the value of the Measurement-Period-UMTS AVP, or null if it has not been set.
      • setMeasurementPeriodUmts

        void setMeasurementPeriodUmts​(MeasurementPeriodUmts measurementPeriodUmts)
        Sets the value of the Measurement-Period-UMTS AVP, of type Enumerated.
        Throws:
        NullPointerException - if measurementPeriodUmts is null.
      • removeMeasurementPeriodUmts

        void removeMeasurementPeriodUmts()
        Removes the Measurement-Period-UMTS AVP from the MDT-Configuration AVP. If the Measurement-Period-UMTS AVP is not present, this method returns silently.
      • hasCollectionPeriodRrmLte

        boolean hasCollectionPeriodRrmLte()
        Returns true if the Collection-Period-RRM-LTE AVP is present in the MDT-Configuration AVP.
      • getCollectionPeriodRrmLte

        CollectionPeriodRrmLte getCollectionPeriodRrmLte()
        Returns the value of the Collection-Period-RRM-LTE AVP, of type Enumerated.
        Returns:
        the value of the Collection-Period-RRM-LTE AVP, or null if it has not been set.
      • setCollectionPeriodRrmLte

        void setCollectionPeriodRrmLte​(CollectionPeriodRrmLte collectionPeriodRrmLte)
        Sets the value of the Collection-Period-RRM-LTE AVP, of type Enumerated.
        Throws:
        NullPointerException - if collectionPeriodRrmLte is null.
      • removeCollectionPeriodRrmLte

        void removeCollectionPeriodRrmLte()
        Removes the Collection-Period-RRM-LTE AVP from the MDT-Configuration AVP. If the Collection-Period-RRM-LTE AVP is not present, this method returns silently.
      • hasCollectionPeriodRrmUmts

        boolean hasCollectionPeriodRrmUmts()
        Returns true if the Collection-Period-RRM-UMTS AVP is present in the MDT-Configuration AVP.
      • getCollectionPeriodRrmUmts

        CollectionPeriodRrmUmts getCollectionPeriodRrmUmts()
        Returns the value of the Collection-Period-RRM-UMTS AVP, of type Enumerated.
        Returns:
        the value of the Collection-Period-RRM-UMTS AVP, or null if it has not been set.
      • setCollectionPeriodRrmUmts

        void setCollectionPeriodRrmUmts​(CollectionPeriodRrmUmts collectionPeriodRrmUmts)
        Sets the value of the Collection-Period-RRM-UMTS AVP, of type Enumerated.
        Throws:
        NullPointerException - if collectionPeriodRrmUmts is null.
      • removeCollectionPeriodRrmUmts

        void removeCollectionPeriodRrmUmts()
        Removes the Collection-Period-RRM-UMTS AVP from the MDT-Configuration AVP. If the Collection-Period-RRM-UMTS AVP is not present, this method returns silently.
      • hasPositioningMethod

        boolean hasPositioningMethod()
        Returns true if the Positioning-Method AVP is present in the MDT-Configuration AVP.
      • getPositioningMethod

        byte[] getPositioningMethod()
        Returns the value of the Positioning-Method AVP, of type OctetString.
        Returns:
        the value of the Positioning-Method AVP, or null if it has not been set.
      • setPositioningMethod

        void setPositioningMethod​(byte[] positioningMethod)
        Sets the value of the Positioning-Method AVP, of type OctetString.
        Throws:
        NullPointerException - if positioningMethod is null.
      • removePositioningMethod

        void removePositioningMethod()
        Removes the Positioning-Method AVP from the MDT-Configuration AVP. If the Positioning-Method AVP is not present, this method returns silently.
      • hasMeasurementQuantity

        boolean hasMeasurementQuantity()
        Returns true if the Measurement-Quantity AVP is present in the MDT-Configuration AVP.
      • getMeasurementQuantity

        byte[] getMeasurementQuantity()
        Returns the value of the Measurement-Quantity AVP, of type OctetString.
        Returns:
        the value of the Measurement-Quantity AVP, or null if it has not been set.
      • setMeasurementQuantity

        void setMeasurementQuantity​(byte[] measurementQuantity)
        Sets the value of the Measurement-Quantity AVP, of type OctetString.
        Throws:
        NullPointerException - if measurementQuantity is null.
      • removeMeasurementQuantity

        void removeMeasurementQuantity()
        Removes the Measurement-Quantity AVP from the MDT-Configuration AVP. If the Measurement-Quantity AVP is not present, this method returns silently.
      • hasEventThresholdEvent1f

        boolean hasEventThresholdEvent1f()
        Returns true if the Event-Threshold-Event-1F AVP is present in the MDT-Configuration AVP.
      • getEventThresholdEvent1f

        int getEventThresholdEvent1f()
        Returns the value of the Event-Threshold-Event-1F AVP, of type Integer32. Use hasEventThresholdEvent1f() to check the existence of this AVP.
        Returns:
        the value of the Event-Threshold-Event-1F AVP
        Throws:
        IllegalStateException - if the Event-Threshold-Event-1F AVP has not been set.
      • setEventThresholdEvent1f

        void setEventThresholdEvent1f​(int eventThresholdEvent1f)
        Sets the value of the Event-Threshold-Event-1F AVP, of type Integer32.
      • removeEventThresholdEvent1f

        void removeEventThresholdEvent1f()
        Removes the Event-Threshold-Event-1F AVP from the MDT-Configuration AVP. If the Event-Threshold-Event-1F AVP is not present, this method returns silently.
      • hasEventThresholdEvent1i

        boolean hasEventThresholdEvent1i()
        Returns true if the Event-Threshold-Event-1I AVP is present in the MDT-Configuration AVP.
      • getEventThresholdEvent1i

        int getEventThresholdEvent1i()
        Returns the value of the Event-Threshold-Event-1I AVP, of type Integer32. Use hasEventThresholdEvent1i() to check the existence of this AVP.
        Returns:
        the value of the Event-Threshold-Event-1I AVP
        Throws:
        IllegalStateException - if the Event-Threshold-Event-1I AVP has not been set.
      • setEventThresholdEvent1i

        void setEventThresholdEvent1i​(int eventThresholdEvent1i)
        Sets the value of the Event-Threshold-Event-1I AVP, of type Integer32.
      • removeEventThresholdEvent1i

        void removeEventThresholdEvent1i()
        Removes the Event-Threshold-Event-1I AVP from the MDT-Configuration AVP. If the Event-Threshold-Event-1I AVP is not present, this method returns silently.
      • getMdtAllowedPlmnIds

        byte[][] getMdtAllowedPlmnIds()
        Returns the set of MDT-Allowed-PLMN-Id AVPs. The returned array contains the AVPs in the order they appear in the MDT-Configuration AVP. A return value of null implies that no MDT-Allowed-PLMN-Id AVPs have been set. The elements in the given array are byte[] objects.
      • setMdtAllowedPlmnId

        void setMdtAllowedPlmnId​(byte[] mdtAllowedPlmnId)
        Sets a single MDT-Allowed-PLMN-Id AVP in the MDT-Configuration AVP, of type OctetString.
        Throws:
        NullPointerException - if mdtAllowedPlmnId is null.
      • setMdtAllowedPlmnIds

        void setMdtAllowedPlmnIds​(byte[][] mdtAllowedPlmnIds)
        Sets the set of MDT-Allowed-PLMN-Id AVPs, with all the values in the given array. The AVPs will be added to the MDT-Configuration 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 getMdtAllowedPlmnIds() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if mdtAllowedPlmnIds is null.
      • removeMdtAllowedPlmnIds

        void removeMdtAllowedPlmnIds()
        Removes all MDT-Allowed-PLMN-Id AVPs from the MDT-Configuration AVP. If no MDT-Allowed-PLMN-Id AVPs are 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 MDT-Configuration 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 MDT-Configuration 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 MDT-Configuration AVP. If no extension AVPs are present, this method returns silently.