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

Interface MmsInformation

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface MmsInformation
extends GroupedAvp
    Defines an interface representing the MMS-Information grouped AVP type. From the Diameter Ro Reference Point Protocol Details (3GPP TS 32.299 V9.6.0) specification: 
     7.2.110      MMS-Information AVP
 
 The MMS-Information AVP (AVP code 877) is of type Grouped. Its purpose is
 to allow the transmission of additional MMS service specific information
 elements.
 It has the following ABNF grammar:  
 (Note: the *[ AVP ] is not part of 3GPP TS 32.299, it was added to allow 
 for more flexibility for extensions to Diameter Ro.)
 
     MMS-Information ::=    < AVP Header: 877>
                            [ Originator-Address ]
                          * [ Recipient-Address ]
                            [ Submission-Time ]
                            [ MM-Content-Type ]
                            [ Priority ]
                            [ Message-ID ]
                            [ Message-Type ]
                            [ Message-Size ]
                            [ Message-Class ]
                            [ Delivery-Report-Requested ]
                            [ Read-Reply-Report-Requested ]
                            [ MMBox-Storage-Requested ]
                            [ Applic-ID ]
                            [ Reply-Applic-ID ]
                            [ Aux-Applic-Info ]
                            [ Content-Class ]
                            [ DRM-Content ]
                            [ Adaptations ]
                            [ VASP-Id ]
                            [ VAS-Id ]
                           *[ AVP ]

    • Method Detail

      • hasOriginatorAddress

        boolean hasOriginatorAddress()
        Returns true if the Originator-Address AVP is present in the MMS-Information AVP.

      • getOriginatorAddress

        OriginatorAddress getOriginatorAddress()
        Returns the value of the Originator-Address AVP, of type Grouped.
        Returns:
        the value of the Originator-Address AVP, or null if it has not been set.

      • setOriginatorAddress

        void setOriginatorAddress​(OriginatorAddress originatorAddress)
        Sets the value of the Originator-Address AVP, of type Grouped.
        Throws:
        NullPointerException - if originatorAddress is null.

      • removeOriginatorAddress

        void removeOriginatorAddress()
        Removes the Originator-Address AVP from the MMS-Information AVP. If the Originator-Address AVP is not present, this method returns silently.

      • getRecipientAddresses

        RecipientAddress[] getRecipientAddresses()
        Returns the set of Recipient-Address AVPs. The returned array contains the AVPs in the order they appear in the MMS-Information AVP. A return value of null implies that no Recipient-Address AVPs have been set. The elements in the given array are RecipientAddress objects.

      • setRecipientAddress

        void setRecipientAddress​(RecipientAddress recipientAddress)
        Sets a single Recipient-Address AVP in the MMS-Information AVP, of type Grouped.
        Throws:
        NullPointerException - if recipientAddress is null.

      • setRecipientAddresses

        void setRecipientAddresses​(RecipientAddress[] recipientAddresses)
        Sets the set of Recipient-Address AVPs, with all the values in the given array. The AVPs will be added to the MMS-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 getRecipientAddresses() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if recipientAddresses is null.

      • removeRecipientAddresses

        void removeRecipientAddresses()
        Removes all Recipient-Address AVPs from the MMS-Information AVP. If no Recipient-Address AVPs are present, this method returns silently.

      • hasSubmissionTime

        boolean hasSubmissionTime()
        Returns true if the Submission-Time AVP is present in the MMS-Information AVP.

      • getSubmissionTime

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

      • setSubmissionTime

        void setSubmissionTime​(Date submissionTime)
        Sets the value of the Submission-Time AVP, of type Time.
        Throws:
        NullPointerException - if submissionTime is null.

      • removeSubmissionTime

        void removeSubmissionTime()
        Removes the Submission-Time AVP from the MMS-Information AVP. If the Submission-Time AVP is not present, this method returns silently.

      • hasMmContentType

        boolean hasMmContentType()
        Returns true if the MM-Content-Type AVP is present in the MMS-Information AVP.

      • getMmContentType

        MmContentType getMmContentType()
        Returns the value of the MM-Content-Type AVP, of type Grouped.
        Returns:
        the value of the MM-Content-Type AVP, or null if it has not been set.

      • setMmContentType

        void setMmContentType​(MmContentType mmContentType)
        Sets the value of the MM-Content-Type AVP, of type Grouped.
        Throws:
        NullPointerException - if mmContentType is null.

      • removeMmContentType

        void removeMmContentType()
        Removes the MM-Content-Type AVP from the MMS-Information AVP. If the MM-Content-Type AVP is not present, this method returns silently.

      • hasPriority

        boolean hasPriority()
        Returns true if the Priority AVP is present in the MMS-Information AVP.

      • getPriority

        Priority getPriority()
        Returns the value of the Priority AVP, of type Enumerated.
        Returns:
        the value of the Priority AVP, or null if it has not been set.

      • setPriority

        void setPriority​(Priority priority)
        Sets the value of the Priority AVP, of type Enumerated.
        Throws:
        NullPointerException - if priority is null.

      • removePriority

        void removePriority()
        Removes the Priority AVP from the MMS-Information AVP. If the Priority AVP is not present, this method returns silently.

      • hasMessageId

        boolean hasMessageId()
        Returns true if the Message-ID AVP is present in the MMS-Information AVP.

      • getMessageId

        String getMessageId()
        Returns the value of the Message-ID AVP, of type UTF8String.
        Returns:
        the value of the Message-ID AVP, or null if it has not been set.

      • setMessageId

        void setMessageId​(String messageId)
        Sets the value of the Message-ID AVP, of type UTF8String.
        Throws:
        NullPointerException - if messageId is null.

      • removeMessageId

        void removeMessageId()
        Removes the Message-ID AVP from the MMS-Information AVP. If the Message-ID AVP is not present, this method returns silently.

      • hasMessageType

        boolean hasMessageType()
        Returns true if the Message-Type AVP is present in the MMS-Information AVP.

      • getMessageType

        MessageType getMessageType()
        Returns the value of the Message-Type AVP, of type Enumerated.
        Returns:
        the value of the Message-Type AVP, or null if it has not been set.

      • setMessageType

        void setMessageType​(MessageType messageType)
        Sets the value of the Message-Type AVP, of type Enumerated.
        Throws:
        NullPointerException - if messageType is null.

      • removeMessageType

        void removeMessageType()
        Removes the Message-Type AVP from the MMS-Information AVP. If the Message-Type AVP is not present, this method returns silently.

      • hasMessageSize

        boolean hasMessageSize()
        Returns true if the Message-Size AVP is present in the MMS-Information AVP.

      • getMessageSize

        long getMessageSize()
        Returns the value of the Message-Size AVP, of type Unsigned32. Use hasMessageSize() to check the existence of this AVP.
        Returns:
        the value of the Message-Size AVP
        Throws:
        IllegalStateException - if the Message-Size AVP has not been set.

      • setMessageSize

        void setMessageSize​(long messageSize)
        Sets the value of the Message-Size AVP, of type Unsigned32.

      • removeMessageSize

        void removeMessageSize()
        Removes the Message-Size AVP from the MMS-Information AVP. If the Message-Size AVP is not present, this method returns silently.

      • hasMessageClass

        boolean hasMessageClass()
        Returns true if the Message-Class AVP is present in the MMS-Information AVP.

      • getMessageClass

        MessageClass getMessageClass()
        Returns the value of the Message-Class AVP, of type Grouped.
        Returns:
        the value of the Message-Class AVP, or null if it has not been set.

      • setMessageClass

        void setMessageClass​(MessageClass messageClass)
        Sets the value of the Message-Class AVP, of type Grouped.
        Throws:
        NullPointerException - if messageClass is null.

      • removeMessageClass

        void removeMessageClass()
        Removes the Message-Class AVP from the MMS-Information AVP. If the Message-Class AVP is not present, this method returns silently.

      • hasDeliveryReportRequested

        boolean hasDeliveryReportRequested()
        Returns true if the Delivery-Report-Requested AVP is present in the MMS-Information AVP.

      • getDeliveryReportRequested

        DeliveryReportRequested getDeliveryReportRequested()
        Returns the value of the Delivery-Report-Requested AVP, of type Enumerated.
        Returns:
        the value of the Delivery-Report-Requested AVP, or null if it has not been set.

      • setDeliveryReportRequested

        void setDeliveryReportRequested​(DeliveryReportRequested deliveryReportRequested)
        Sets the value of the Delivery-Report-Requested AVP, of type Enumerated.
        Throws:
        NullPointerException - if deliveryReportRequested is null.

      • removeDeliveryReportRequested

        void removeDeliveryReportRequested()
        Removes the Delivery-Report-Requested AVP from the MMS-Information AVP. If the Delivery-Report-Requested AVP is not present, this method returns silently.

      • hasReadReplyReportRequested

        boolean hasReadReplyReportRequested()
        Returns true if the Read-Reply-Report-Requested AVP is present in the MMS-Information AVP.

      • getReadReplyReportRequested

        ReadReplyReportRequested getReadReplyReportRequested()
        Returns the value of the Read-Reply-Report-Requested AVP, of type Enumerated.
        Returns:
        the value of the Read-Reply-Report-Requested AVP, or null if it has not been set.

      • setReadReplyReportRequested

        void setReadReplyReportRequested​(ReadReplyReportRequested readReplyReportRequested)
        Sets the value of the Read-Reply-Report-Requested AVP, of type Enumerated.
        Throws:
        NullPointerException - if readReplyReportRequested is null.

      • removeReadReplyReportRequested

        void removeReadReplyReportRequested()
        Removes the Read-Reply-Report-Requested AVP from the MMS-Information AVP. If the Read-Reply-Report-Requested AVP is not present, this method returns silently.

      • hasMmboxStorageRequested

        boolean hasMmboxStorageRequested()
        Returns true if the MMBox-Storage-Requested AVP is present in the MMS-Information AVP.

      • getMmboxStorageRequested

        MmboxStorageRequested getMmboxStorageRequested()
        Returns the value of the MMBox-Storage-Requested AVP, of type Enumerated.
        Returns:
        the value of the MMBox-Storage-Requested AVP, or null if it has not been set.

      • setMmboxStorageRequested

        void setMmboxStorageRequested​(MmboxStorageRequested mmboxStorageRequested)
        Sets the value of the MMBox-Storage-Requested AVP, of type Enumerated.
        Throws:
        NullPointerException - if mmboxStorageRequested is null.

      • removeMmboxStorageRequested

        void removeMmboxStorageRequested()
        Removes the MMBox-Storage-Requested AVP from the MMS-Information AVP. If the MMBox-Storage-Requested AVP is not present, this method returns silently.

      • hasApplicId

        boolean hasApplicId()
        Returns true if the Applic-ID AVP is present in the MMS-Information AVP.

      • getApplicId

        String getApplicId()
        Returns the value of the Applic-ID AVP, of type UTF8String.
        Returns:
        the value of the Applic-ID AVP, or null if it has not been set.

      • setApplicId

        void setApplicId​(String applicId)
        Sets the value of the Applic-ID AVP, of type UTF8String.
        Throws:
        NullPointerException - if applicId is null.

      • removeApplicId

        void removeApplicId()
        Removes the Applic-ID AVP from the MMS-Information AVP. If the Applic-ID AVP is not present, this method returns silently.

      • hasReplyApplicId

        boolean hasReplyApplicId()
        Returns true if the Reply-Applic-ID AVP is present in the MMS-Information AVP.

      • getReplyApplicId

        String getReplyApplicId()
        Returns the value of the Reply-Applic-ID AVP, of type UTF8String.
        Returns:
        the value of the Reply-Applic-ID AVP, or null if it has not been set.

      • setReplyApplicId

        void setReplyApplicId​(String replyApplicId)
        Sets the value of the Reply-Applic-ID AVP, of type UTF8String.
        Throws:
        NullPointerException - if replyApplicId is null.

      • removeReplyApplicId

        void removeReplyApplicId()
        Removes the Reply-Applic-ID AVP from the MMS-Information AVP. If the Reply-Applic-ID AVP is not present, this method returns silently.

      • hasAuxApplicInfo

        boolean hasAuxApplicInfo()
        Returns true if the Aux-Applic-Info AVP is present in the MMS-Information AVP.

      • getAuxApplicInfo

        String getAuxApplicInfo()
        Returns the value of the Aux-Applic-Info AVP, of type UTF8String.
        Returns:
        the value of the Aux-Applic-Info AVP, or null if it has not been set.

      • setAuxApplicInfo

        void setAuxApplicInfo​(String auxApplicInfo)
        Sets the value of the Aux-Applic-Info AVP, of type UTF8String.
        Throws:
        NullPointerException - if auxApplicInfo is null.

      • removeAuxApplicInfo

        void removeAuxApplicInfo()
        Removes the Aux-Applic-Info AVP from the MMS-Information AVP. If the Aux-Applic-Info AVP is not present, this method returns silently.

      • hasContentClass

        boolean hasContentClass()
        Returns true if the Content-Class AVP is present in the MMS-Information AVP.

      • getContentClass

        ContentClass getContentClass()
        Returns the value of the Content-Class AVP, of type Enumerated.
        Returns:
        the value of the Content-Class AVP, or null if it has not been set.

      • setContentClass

        void setContentClass​(ContentClass contentClass)
        Sets the value of the Content-Class AVP, of type Enumerated.
        Throws:
        NullPointerException - if contentClass is null.

      • removeContentClass

        void removeContentClass()
        Removes the Content-Class AVP from the MMS-Information AVP. If the Content-Class AVP is not present, this method returns silently.

      • hasDrmContent

        boolean hasDrmContent()
        Returns true if the DRM-Content AVP is present in the MMS-Information AVP.

      • getDrmContent

        DrmContent getDrmContent()
        Returns the value of the DRM-Content AVP, of type Enumerated.
        Returns:
        the value of the DRM-Content AVP, or null if it has not been set.

      • setDrmContent

        void setDrmContent​(DrmContent drmContent)
        Sets the value of the DRM-Content AVP, of type Enumerated.
        Throws:
        NullPointerException - if drmContent is null.

      • removeDrmContent

        void removeDrmContent()
        Removes the DRM-Content AVP from the MMS-Information AVP. If the DRM-Content AVP is not present, this method returns silently.

      • hasAdaptations

        boolean hasAdaptations()
        Returns true if the Adaptations AVP is present in the MMS-Information AVP.

      • getAdaptations

        Adaptations getAdaptations()
        Returns the value of the Adaptations AVP, of type Enumerated.
        Returns:
        the value of the Adaptations AVP, or null if it has not been set.

      • setAdaptations

        void setAdaptations​(Adaptations adaptations)
        Sets the value of the Adaptations AVP, of type Enumerated.
        Throws:
        NullPointerException - if adaptations is null.

      • removeAdaptations

        void removeAdaptations()
        Removes the Adaptations AVP from the MMS-Information AVP. If the Adaptations AVP is not present, this method returns silently.

      • hasVaspId

        boolean hasVaspId()
        Returns true if the VASP-Id AVP is present in the MMS-Information AVP.

      • getVaspId

        String getVaspId()
        Returns the value of the VASP-Id AVP, of type UTF8String.
        Returns:
        the value of the VASP-Id AVP, or null if it has not been set.

      • setVaspId

        void setVaspId​(String vaspId)
        Sets the value of the VASP-Id AVP, of type UTF8String.
        Throws:
        NullPointerException - if vaspId is null.

      • removeVaspId

        void removeVaspId()
        Removes the VASP-Id AVP from the MMS-Information AVP. If the VASP-Id AVP is not present, this method returns silently.

      • hasVasId

        boolean hasVasId()
        Returns true if the VAS-Id AVP is present in the MMS-Information AVP.

      • getVasId

        String getVasId()
        Returns the value of the VAS-Id AVP, of type UTF8String.
        Returns:
        the value of the VAS-Id AVP, or null if it has not been set.

      • setVasId

        void setVasId​(String vasId)
        Sets the value of the VAS-Id AVP, of type UTF8String.
        Throws:
        NullPointerException - if vasId is null.

      • removeVasId

        void removeVasId()
        Removes the VAS-Id AVP from the MMS-Information AVP. If the VAS-Id 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 MMS-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 MMS-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 MMS-Information AVP. If no extension AVPs are present, this method returns silently.