net.java.slee.resource.diameter.ro.events.avp
Interface MmsInformation

All Superinterfaces:

java.lang.Cloneable, net.java.slee.resource.diameter.base.events.avp.DiameterAvp, net.java.slee.resource.diameter.base.events.avp.GroupedAvp

All Known Implementing Classes:

MmsInformationImpl

public interface MmsInformation
extends net.java.slee.resource.diameter.base.events.avp.GroupedAvp

Defines an interface representing the MMS-Information grouped AVP type.

From the Diameter Ro Reference Point Protocol Details (3GPP TS 32.299 V7.1.0) specification:

 7.2.65 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-Information ] #exclude 
      [ Applic-ID ] 
      [ Reply-Applic-ID ] 
      [ Aux-Applic-Info ] 
      [ Content-Class ] 
      [ DRM-Content ] 
      [ Adaptations ] 
      [ VASP-Id ] 
      [ VAS-Id ] 
     *[ AVP ]
 

Author:

Alexandre Mendonca , Bartosz Baranowski

Field Summary

Fields inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp

FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT

Method Summary

Adaptations	getAdaptations() Returns the value of the Adaptations AVP, of type Enumerated.
java.lang.String	getApplicId() Returns the value of the Applic-ID AVP, of type UTF8String.
java.lang.String	getAuxApplicInfo() Returns the value of the Aux-Applic-Info AVP, of type UTF8String.
ContentClass	getContentClass() Returns the value of the Content-Class AVP, of type Enumerated.
DeliveryReportRequested	getDeliveryReportRequested() Returns the value of the Delivery-Report-Requested AVP, of type Enumerated.
DrmContent	getDrmContent() Returns the value of the DRM-Content AVP, of type Enumerated.
net.java.slee.resource.diameter.base.events.avp.DiameterAvp[]	getExtensionAvps() Returns the set of extension AVPs.
MessageClass	getMessageClass() Returns the value of the Message-Class AVP, of type Grouped.
java.lang.String	getMessageId() Returns the value of the Message-ID AVP, of type UTF8String.
long	getMessageSize() Returns the value of the Message-Size AVP, of type Unsigned32.
MessageType	getMessageType() Returns the value of the Message-Type AVP, of type Enumerated.
MmContentType	getMmContentType() Returns the value of the MM-Content-Type AVP, of type Grouped.
OriginatorAddress	getOriginatorAddress() Returns the value of the Originator-Address AVP, of type Grouped.
Priority	getPriority() Returns the value of the Priority AVP, of type Enumerated.
ReadReplyReportRequested	getReadReplyReportRequested() Returns the value of the Read-Reply-Report-Requested AVP, of type Enumerated.
RecipientAddress[]	getRecipientAddresses() Returns the set of Recipient-Address AVPs.
java.lang.String	getReplyApplicId() Returns the value of the Reply-Applic-ID AVP, of type UTF8String.
java.util.Date	getSubmissionTime() Returns the value of the Submission-Time AVP, of type Time.
java.lang.String	getVasId() Returns the value of the VAS-Id AVP, of type UTF8String.
java.lang.String	getVaspId() Returns the value of the VASP-Id AVP, of type UTF8String.
boolean	hasAdaptations() Returns true if the Adaptations AVP is present in the message.
boolean	hasApplicId() Returns true if the Applic-ID AVP is present in the message.
boolean	hasAuxApplicInfo() Returns true if the Aux-Applic-Info AVP is present in the message.
boolean	hasContentClass() Returns true if the Content-Class AVP is present in the message.
boolean	hasDeliveryReportRequested() Returns true if the Delivery-Report-Requested AVP is present in the message.
boolean	hasDrmContent() Returns true if the DRM-Content AVP is present in the message.
boolean	hasMessageClass() Returns true if the Message-Class AVP is present in the message.
boolean	hasMessageId() Returns true if the Message-ID AVP is present in the message.
boolean	hasMessageSize() Returns true if the Message-Size AVP is present in the message.
boolean	hasMessageType() Returns true if the Message-Type AVP is present in the message.
boolean	hasMmContentType() Returns true if the MM-Content-Type AVP is present in the message.
boolean	hasOriginatorAddress() Returns true if the Originator-Address AVP is present in the message.
boolean	hasPriority() Returns true if the Priority AVP is present in the message.
boolean	hasReadReplyReportRequested() Returns true if the Read-Reply-Report-Requested AVP is present in the message.
boolean	hasReplyApplicId() Returns true if the Reply-Applic-ID AVP is present in the message.
boolean	hasSubmissionTime() Returns true if the Submission-Time AVP is present in the message.
boolean	hasVasId() Returns true if the VAS-Id AVP is present in the message.
boolean	hasVaspId() Returns true if the VASP-Id AVP is present in the message.
void	setAdaptations(Adaptations adaptations) Sets the value of the Adaptations AVP, of type Enumerated.
void	setApplicId(java.lang.String applicId) Sets the value of the Applic-ID AVP, of type UTF8String.
void	setAuxApplicInfo(java.lang.String auxApplicInfo) Sets the value of the Aux-Applic-Info AVP, of type UTF8String.
void	setContentClass(ContentClass contentClass) Sets the value of the Content-Class AVP, of type Enumerated.
void	setDeliveryReportRequested(DeliveryReportRequested deliveryReportRequested) Sets the value of the Delivery-Report-Requested AVP, of type Enumerated.
void	setDrmContent(DrmContent drmContent) Sets the value of the DRM-Content AVP, of type Enumerated.
void	setExtensionAvps(net.java.slee.resource.diameter.base.events.avp.DiameterAvp[] avps) Sets the set of extension AVPs with all the values in the given array.
void	setMessageClass(MessageClass messageClass) Sets the value of the Message-Class AVP, of type Grouped.
void	setMessageId(java.lang.String messageId) Sets the value of the Message-ID AVP, of type UTF8String.
void	setMessageSize(long messageSize) Sets the value of the Message-Size AVP, of type Unsigned32.
void	setMessageType(MessageType messageType) Sets the value of the Message-Type AVP, of type Enumerated.
void	setMmContentType(MmContentType mmContentType) Sets the value of the MM-Content-Type AVP, of type Grouped.
void	setOriginatorAddress(OriginatorAddress originatorAddress) Sets the value of the Originator-Address AVP, of type Grouped.
void	setPriority(Priority priority) Sets the value of the Priority AVP, of type Enumerated.
void	setReadReplyReportRequested(ReadReplyReportRequested readReplyReportRequested) Sets the value of the Read-Reply-Report-Requested AVP, of type Enumerated.
void	setRecipientAddress(RecipientAddress recipientAddress) Sets a single Recipient-Address AVP in the message, of type Grouped.
void	setRecipientAddresses(RecipientAddress[] recipientAddresses) Sets the set of Recipient-Address AVPs, with all the values in the given array.
void	setReplyApplicId(java.lang.String replyApplicId) Sets the value of the Reply-Applic-ID AVP, of type UTF8String.
void	setSubmissionTime(java.util.Date submissionTime) Sets the value of the Submission-Time AVP, of type Time.
void	setVasId(java.lang.String vasId) Sets the value of the VAS-Id AVP, of type UTF8String.
void	setVaspId(java.lang.String vaspId) Sets the value of the VASP-Id AVP, of type UTF8String.

Methods inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp

byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorId, intValue, longValue, octetStringValue, stringValue

Method Detail

getAdaptations

Adaptations getAdaptations()

Returns the value of the Adaptations AVP, of type Enumerated. A return value of null implies that the AVP has not been set.

getApplicId

java.lang.String getApplicId()

Returns the value of the Applic-ID AVP, of type UTF8String. A return value of null implies that the AVP has not been set.

getAuxApplicInfo

java.lang.String getAuxApplicInfo()

Returns the value of the Aux-Applic-Info AVP, of type UTF8String. A return value of null implies that the AVP has not been set.

getContentClass

ContentClass getContentClass()

Returns the value of the Content-Class AVP, of type Enumerated. A return value of null implies that the AVP has not been set.

getDeliveryReportRequested

DeliveryReportRequested getDeliveryReportRequested()

Returns the value of the Delivery-Report-Requested AVP, of type Enumerated. A return value of null implies that the AVP has not been set.

getDrmContent

DrmContent getDrmContent()

Returns the value of the DRM-Content AVP, of type Enumerated. A return value of null implies that the AVP has not been set.

getExtensionAvps

net.java.slee.resource.diameter.base.events.avp.DiameterAvp[] getExtensionAvps()

Returns the set of extension AVPs. The returned array contains the extension AVPs in the order they appear in the message. A return value of null implies that no extensions AVPs have been set.

Specified by:

getExtensionAvps in interface net.java.slee.resource.diameter.base.events.avp.GroupedAvp

getMessageClass

MessageClass getMessageClass()

Returns the value of the Message-Class AVP, of type Grouped. A return value of null implies that the AVP has not been set.

getMessageId

java.lang.String getMessageId()

Returns the value of the Message-ID AVP, of type UTF8String. A return value of null implies that the AVP has not been set.

getMessageSize

long getMessageSize()

Returns the value of the Message-Size AVP, of type Unsigned32. A return value of null implies that the AVP has not been set.

getMessageType

MessageType getMessageType()

Returns the value of the Message-Type AVP, of type Enumerated. A return value of null implies that the AVP has not been set.

getMmContentType

MmContentType getMmContentType()

Returns the value of the MM-Content-Type AVP, of type Grouped. A return value of null implies that the AVP has not been set.

getOriginatorAddress

OriginatorAddress getOriginatorAddress()

Returns the value of the Originator-Address AVP, of type Grouped. A return value of null implies that the AVP has not been set.

getPriority

Priority getPriority()

Returns the value of the Priority AVP, of type Enumerated. A return value of null implies that the AVP has not been set.

getReadReplyReportRequested

ReadReplyReportRequested getReadReplyReportRequested()

Returns the value of the Read-Reply-Report-Requested AVP, of type Enumerated. A return value of null implies that the AVP has not been set.

getRecipientAddresses

RecipientAddress[] getRecipientAddresses()

Returns the set of Recipient-Address AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Recipient-Address AVPs have been set. The elements in the given array are RecipientAddress objects.

getReplyApplicId

java.lang.String getReplyApplicId()

Returns the value of the Reply-Applic-ID AVP, of type UTF8String. A return value of null implies that the AVP has not been set.

getSubmissionTime

java.util.Date getSubmissionTime()

Returns the value of the Submission-Time AVP, of type Time. A return value of null implies that the AVP has not been set.

getVasId

java.lang.String getVasId()

Returns the value of the VAS-Id AVP, of type UTF8String. A return value of null implies that the AVP has not been set.

getVaspId

java.lang.String getVaspId()

Returns the value of the VASP-Id AVP, of type UTF8String. A return value of null implies that the AVP has not been set.

hasAdaptations

boolean hasAdaptations()

Returns true if the Adaptations AVP is present in the message.

hasApplicId

boolean hasApplicId()

Returns true if the Applic-ID AVP is present in the message.

hasAuxApplicInfo

boolean hasAuxApplicInfo()

Returns true if the Aux-Applic-Info AVP is present in the message.

hasContentClass

boolean hasContentClass()

Returns true if the Content-Class AVP is present in the message.

hasDeliveryReportRequested

boolean hasDeliveryReportRequested()

Returns true if the Delivery-Report-Requested AVP is present in the message.

hasDrmContent

boolean hasDrmContent()

Returns true if the DRM-Content AVP is present in the message.

hasMessageClass

boolean hasMessageClass()

Returns true if the Message-Class AVP is present in the message.

hasMessageId

boolean hasMessageId()

Returns true if the Message-ID AVP is present in the message.

hasMessageSize

boolean hasMessageSize()

Returns true if the Message-Size AVP is present in the message.

hasMessageType

boolean hasMessageType()

Returns true if the Message-Type AVP is present in the message.

hasMmContentType

boolean hasMmContentType()

Returns true if the MM-Content-Type AVP is present in the message.

hasOriginatorAddress

boolean hasOriginatorAddress()

Returns true if the Originator-Address AVP is present in the message.

hasPriority

boolean hasPriority()

Returns true if the Priority AVP is present in the message.

hasReadReplyReportRequested

boolean hasReadReplyReportRequested()

Returns true if the Read-Reply-Report-Requested AVP is present in the message.

hasReplyApplicId

boolean hasReplyApplicId()

Returns true if the Reply-Applic-ID AVP is present in the message.

hasSubmissionTime

boolean hasSubmissionTime()

Returns true if the Submission-Time AVP is present in the message.

hasVasId

boolean hasVasId()

Returns true if the VAS-Id AVP is present in the message.

hasVaspId

boolean hasVaspId()

Returns true if the VASP-Id AVP is present in the message.

setAdaptations

void setAdaptations(Adaptations adaptations)

Sets the value of the Adaptations AVP, of type Enumerated.

setApplicId

void setApplicId(java.lang.String applicId)

Sets the value of the Applic-ID AVP, of type UTF8String.

setAuxApplicInfo

void setAuxApplicInfo(java.lang.String auxApplicInfo)

Sets the value of the Aux-Applic-Info AVP, of type UTF8String.

setContentClass

void setContentClass(ContentClass contentClass)

Sets the value of the Content-Class AVP, of type Enumerated.

setDeliveryReportRequested

void setDeliveryReportRequested(DeliveryReportRequested deliveryReportRequested)

Sets the value of the Delivery-Report-Requested AVP, of type Enumerated.

setDrmContent

void setDrmContent(DrmContent drmContent)

Sets the value of the DRM-Content AVP, of type Enumerated.

setExtensionAvps

void setExtensionAvps(net.java.slee.resource.diameter.base.events.avp.DiameterAvp[] avps)
                      throws net.java.slee.resource.diameter.base.events.avp.AvpNotAllowedException

Sets the set of extension AVPs with all the values in the given array. The AVPs will be added to message 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.

Specified by:

setExtensionAvps in interface net.java.slee.resource.diameter.base.events.avp.GroupedAvp

Throws:

net.java.slee.resource.diameter.base.events.avp.AvpNotAllowedException

setMessageClass

void setMessageClass(MessageClass messageClass)

Sets the value of the Message-Class AVP, of type Grouped.

setMessageId

void setMessageId(java.lang.String messageId)

Sets the value of the Message-ID AVP, of type UTF8String.

setMessageSize

void setMessageSize(long messageSize)

Sets the value of the Message-Size AVP, of type Unsigned32.

setMessageType

void setMessageType(MessageType messageType)

Sets the value of the Message-Type AVP, of type Enumerated.

setMmContentType

void setMmContentType(MmContentType mmContentType)

Sets the value of the MM-Content-Type AVP, of type Grouped.

setOriginatorAddress

void setOriginatorAddress(OriginatorAddress originatorAddress)

Sets the value of the Originator-Address AVP, of type Grouped.

setPriority

void setPriority(Priority priority)

Sets the value of the Priority AVP, of type Enumerated.

setReadReplyReportRequested

void setReadReplyReportRequested(ReadReplyReportRequested readReplyReportRequested)

Sets the value of the Read-Reply-Report-Requested AVP, of type Enumerated.

setRecipientAddress

void setRecipientAddress(RecipientAddress recipientAddress)

Sets a single Recipient-Address AVP in the message, of type Grouped.

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 message 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.

setReplyApplicId

void setReplyApplicId(java.lang.String replyApplicId)

Sets the value of the Reply-Applic-ID AVP, of type UTF8String.

setSubmissionTime

void setSubmissionTime(java.util.Date submissionTime)

Sets the value of the Submission-Time AVP, of type Time.

setVasId

void setVasId(java.lang.String vasId)

Sets the value of the VAS-Id AVP, of type UTF8String.

setVaspId

void setVaspId(java.lang.String vaspId)

Sets the value of the VASP-Id AVP, of type UTF8String.