com.ibm.diameter.charging.util
Class MMSInformation

java.lang.Object
  extended by com.ibm.diameter.charging.util.MMSInformation

public class MMSInformation
extends java.lang.Object

MMSInformation is a lightweight representation of the Grouped [MMS-Information] Avp. It is used to record accounting and charging information that is specific to the Multimedia Messaging service (MMS).

The [MMS-Information] Avp is defined by the 3GPP in ETSI TS 132 299 V6.9.0 (2006-12) - Diameter charging applications.


Constructor Summary
MMSInformation()
          Constructs an empty MMSInformation object representing the [MMS-Information] Avp.
MMSInformation(java.util.List<Avp> avps)
          Constructs a MMSInformation object representing the Grouped [MMS-Information] Avp.
 
Method Summary
 java.lang.Integer getAdaptations()
          Gets the value corresponding to the payload of the [Adaptations] Avp.
 java.lang.String getApplicId()
          Gets the value corresponding to the payload of the [Applic-Id] Avp.
 java.lang.String getAuxApplicInfo()
          Gets the value corresponding to the payload of the [Aux-Applic-Info] Avp.
 java.lang.Integer getContentClass()
          Gets the value corresponding to the payload of the [Content-Class] Avp.
 java.lang.Integer getDeliveryReportRequested()
          Gets the value corresponding to the payload of the [Delivery-Report-Requested] Avp.
 java.lang.Integer getDrmContent()
          Gets the value corresponding to the payload of the [DRM-Content] Avp.
 MessageClass getMessageClass()
          Gets the value corresponding to the payload of the [Message-Class] Avp.
 java.lang.String getMessageId()
          Gets the value corresponding to the payload of the [Message-Id] Avp.
 java.lang.Integer getMessageSize()
          Gets the value corresponding to the payload of the [Message-Size] Avp.
 java.lang.Integer getMessageType()
          Gets the value corresponding to the payload of the [Message-Type] Avp.
 java.lang.Integer getMmboxStorageRequested()
          Gets the value corresponding to the payload of the [MMBox-Storage-Requested] Avp.
 MMContentType getMmContentType()
          Gets the value corresponding to the payload of the [MM-Content-Type] Avp.
 OriginatorAddress getOriginatorAddress()
          Gets the value corresponding to the payload of the [Originator-Address] Avp.
 java.lang.Integer getPriority()
          Gets the value corresponding to the payload of the [Priority] Avp.
 java.lang.Integer getReadReplyReportRequested()
          Gets the value corresponding to the payload of the [Read-Reply-Report-Requested] Avp.
 RecipientAddress[] getRecipientAddresses()
          Gets the values corresponding to the payloads of the [Recipient-Address] Avps.
 java.lang.String getReplyApplicId()
          Gets the value corresponding to the payload of the [Reply-Applic-Id] Avp.
 java.lang.Long getSubmissionTime()
          Gets the value corresponding to the payload of the [Submission-Time] Avp.
 java.lang.String getVasId()
          Gets the value corresponding to the payload of the [Vas-Id] Avp.
 java.lang.String getVaspId()
          Gets the value corresponding to the payload of the [Vasp-Id] Avp.
 void setAdaptations(java.lang.Integer adaptations)
          Sets the value corresponding to the payload of the [Adaptations] Avp.
 void setApplicId(java.lang.String applicId)
          Sets the value corresponding to the payload of the [Applic-Id] Avp.
 void setAuxApplicInfo(java.lang.String auxApplicInfo)
          Sets the value corresponding to the payload of the [Aux-Applic-Info] Avp.
 void setContentClass(java.lang.Integer contentClass)
          Sets the value corresponding to the payload of the [Content-Class] Avp.
 void setDeliveryReportRequested(java.lang.Integer deliveryReportRequested)
          Sets the value corresponding to the payload of the [Delivery-Report-Requested] Avp.
 void setDrmContent(java.lang.Integer drmContent)
          Sets the value corresponding to the payload of the [DRM-Content] Avp.
 void setMessageClass(MessageClass messageClass)
          Sets the value corresponding to the payload of the [Message-Class] Avp.
 void setMessageId(java.lang.String messageId)
          Sets the value corresponding to the payload of the [Message-Id] Avp.
 void setMessageSize(java.lang.Integer messageSize)
          Sets the value corresponding to the payload of the [Message-Size] Avp.
 void setMessageType(java.lang.Integer messageType)
          Sets the value corresponding to the payload of the [Message-Type] Avp.
 void setMmboxStorageRequested(java.lang.Integer mmboxStorageRequested)
          Sets the value corresponding to the payload of the [MMBox-Storage-Requested] Avp.
 void setMmContentType(MMContentType mmContentType)
          Sets the value corresponding to the payload of the [MM-Content-Type] Avp.
 void setOriginatorAddress(OriginatorAddress originatorAddress)
          Sets the value corresponding to the payload of the [Originator-Address] Avp.
 void setPriority(java.lang.Integer priority)
          Sets the value corresponding to the payload of the [Priority] Avp.
 void setReadReplyReportRequested(java.lang.Integer readReplyReportRequested)
          Sets the value corresponding to the payload of the [Read-Reply-Report-Requested] Avp.
 void setRecipientAddresses(RecipientAddress[] recipientAddresses)
          Sets the values corresponding to the payloads of the [Recipient-Address] Avps.
 void setReplyApplicId(java.lang.String replyApplicId)
          Sets the value corresponding to the payload of the [Reply-Applic-Id] Avp.
 void setSubmissionTime(java.lang.Long submissionTime)
          Sets the value corresponding to the payload of the [Submission-Time] Avp.
 void setVasId(java.lang.String vasId)
          Sets the value corresponding to the payload of the [Vas-Id] Avp.
 void setVaspId(java.lang.String vaspId)
          Sets the value corresponding to the payload of the [Vasp-Id] Avp.
 Avp toAvp()
          Transforms a MMSInformation object into a Grouped [MMS-Information] Avp.
 void validate()
          Validates the members of the MMSInformation object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MMSInformation

public MMSInformation()
Constructs an empty MMSInformation object representing the [MMS-Information] Avp.


MMSInformation

public MMSInformation(java.util.List<Avp> avps)
               throws AvpTransformationException
Constructs a MMSInformation object representing the Grouped [MMS-Information] Avp.

The method takes a List of Avps as an input. If an Avp code inside the list corresponds to a member of MMSInformation, the member will be populated with the Avp value during construction. If an Avp code is unknown, the value will be silently discarded.

Parameters:
avps - a list of Avps that can appear in the Grouped [MMS-Information] Avp.
Throws:
AvpTransformationException - if the Avp value is in an unexpected format.
Method Detail

getAdaptations

public java.lang.Integer getAdaptations()
Gets the value corresponding to the payload of the [Adaptations] Avp.

Returns:
the value corresponding to the payload of the [Adaptations] Avp.

setAdaptations

public void setAdaptations(java.lang.Integer adaptations)
Sets the value corresponding to the payload of the [Adaptations] Avp.

Parameters:
adaptations - the value corresponding to the payload of the [Adaptations] Avp.

getApplicId

public java.lang.String getApplicId()
Gets the value corresponding to the payload of the [Applic-Id] Avp.

Returns:
the value corresponding to the payload of the [Applic-Id] Avp.

setApplicId

public void setApplicId(java.lang.String applicId)
Sets the value corresponding to the payload of the [Applic-Id] Avp.

Parameters:
applicId - the value corresponding to the payload of the [Applic-Id] Avp.

getAuxApplicInfo

public java.lang.String getAuxApplicInfo()
Gets the value corresponding to the payload of the [Aux-Applic-Info] Avp.

Returns:
the value corresponding to the payload of the [Aux-Applic-Info] Avp.

setAuxApplicInfo

public void setAuxApplicInfo(java.lang.String auxApplicInfo)
Sets the value corresponding to the payload of the [Aux-Applic-Info] Avp.

Parameters:
auxApplicInfo - the value corresponding to the payload of the [Aux-Applic-Info] Avp.

getContentClass

public java.lang.Integer getContentClass()
Gets the value corresponding to the payload of the [Content-Class] Avp.

Returns:
the value corresponding to the payload of the [Content-Class] Avp.

setContentClass

public void setContentClass(java.lang.Integer contentClass)
Sets the value corresponding to the payload of the [Content-Class] Avp.

Parameters:
contentClass - the value corresponding to the payload of the [Content-Class] Avp.

getDeliveryReportRequested

public java.lang.Integer getDeliveryReportRequested()
Gets the value corresponding to the payload of the [Delivery-Report-Requested] Avp.

Returns:
the value corresponding to the payload of the [Delivery-Report-Requested] Avp.

setDeliveryReportRequested

public void setDeliveryReportRequested(java.lang.Integer deliveryReportRequested)
Sets the value corresponding to the payload of the [Delivery-Report-Requested] Avp.

Parameters:
deliveryReportRequested - the value corresponding to the payload of the [Delivery-Report-Requested] Avp.

getDrmContent

public java.lang.Integer getDrmContent()
Gets the value corresponding to the payload of the [DRM-Content] Avp.

Returns:
the value corresponding to the payload of the [DRM-Content] Avp.

setDrmContent

public void setDrmContent(java.lang.Integer drmContent)
Sets the value corresponding to the payload of the [DRM-Content] Avp.

Parameters:
drmContent - the value corresponding to the payload of the [DRM-Content] Avp.

getMessageClass

public MessageClass getMessageClass()
Gets the value corresponding to the payload of the [Message-Class] Avp.

Returns:
the value corresponding to the payload of the [Message-Class] Avp.

setMessageClass

public void setMessageClass(MessageClass messageClass)
Sets the value corresponding to the payload of the [Message-Class] Avp.

Parameters:
messageClass - the value corresponding to the payload of the [Message-Class] Avp.

getMessageId

public java.lang.String getMessageId()
Gets the value corresponding to the payload of the [Message-Id] Avp.

Returns:
the value corresponding to the payload of the [Message-Id] Avp.

setMessageId

public void setMessageId(java.lang.String messageId)
Sets the value corresponding to the payload of the [Message-Id] Avp.

Parameters:
messageId - the value corresponding to the payload of the [Message-Id] Avp.

getMessageSize

public java.lang.Integer getMessageSize()
Gets the value corresponding to the payload of the [Message-Size] Avp.

Returns:
the value corresponding to the payload of the [Message-Size] Avp.

setMessageSize

public void setMessageSize(java.lang.Integer messageSize)
Sets the value corresponding to the payload of the [Message-Size] Avp.

Parameters:
messageSize - the value corresponding to the payload of the [Message-Size] Avp.

getMessageType

public java.lang.Integer getMessageType()
Gets the value corresponding to the payload of the [Message-Type] Avp.

Returns:
the value corresponding to the payload of the [Message-Type] Avp.

setMessageType

public void setMessageType(java.lang.Integer messageType)
Sets the value corresponding to the payload of the [Message-Type] Avp.

Parameters:
messageType - the value corresponding to the payload of the [Message-Type] Avp.

getMmboxStorageRequested

public java.lang.Integer getMmboxStorageRequested()
Gets the value corresponding to the payload of the [MMBox-Storage-Requested] Avp.

Returns:
the value corresponding to the payload of the [MMBox-Storage-Requested] Avp.

setMmboxStorageRequested

public void setMmboxStorageRequested(java.lang.Integer mmboxStorageRequested)
Sets the value corresponding to the payload of the [MMBox-Storage-Requested] Avp.

Parameters:
mmboxStorageRequested - the value corresponding to the payload of the [MMBox-Storage-Requested] Avp.

getMmContentType

public MMContentType getMmContentType()
Gets the value corresponding to the payload of the [MM-Content-Type] Avp.

Returns:
the value corresponding to the payload of the [MM-Content-Type] Avp.

setMmContentType

public void setMmContentType(MMContentType mmContentType)
Sets the value corresponding to the payload of the [MM-Content-Type] Avp.

Parameters:
mmContentType - the value corresponding to the payload of the [MM-Content-Type] Avp.

getOriginatorAddress

public OriginatorAddress getOriginatorAddress()
Gets the value corresponding to the payload of the [Originator-Address] Avp.

Returns:
the value corresponding to the payload of the [Originator-Address] Avp.

setOriginatorAddress

public void setOriginatorAddress(OriginatorAddress originatorAddress)
Sets the value corresponding to the payload of the [Originator-Address] Avp.

Parameters:
originatorAddress - the value corresponding to the payload of the [Originator-Address] Avp.

getPriority

public java.lang.Integer getPriority()
Gets the value corresponding to the payload of the [Priority] Avp.

Returns:
the value corresponding to the payload of the [Priority] Avp.

setPriority

public void setPriority(java.lang.Integer priority)
Sets the value corresponding to the payload of the [Priority] Avp.

Parameters:
priority - the value corresponding to the payload of the [Priority] Avp.

getReadReplyReportRequested

public java.lang.Integer getReadReplyReportRequested()
Gets the value corresponding to the payload of the [Read-Reply-Report-Requested] Avp.

Returns:
the value corresponding to the payload of the [Read-Reply-Report-Requested] Avp.

setReadReplyReportRequested

public void setReadReplyReportRequested(java.lang.Integer readReplyReportRequested)
Sets the value corresponding to the payload of the [Read-Reply-Report-Requested] Avp.

Parameters:
readReplyReportRequested - the value corresponding to the payload of the [Read-Reply-Report-Requested] Avp.

getRecipientAddresses

public RecipientAddress[] getRecipientAddresses()
Gets the values corresponding to the payloads of the [Recipient-Address] Avps.

Returns:
the values corresponding to the payloads of the [Recipient-Address] Avps.

setRecipientAddresses

public void setRecipientAddresses(RecipientAddress[] recipientAddresses)
Sets the values corresponding to the payloads of the [Recipient-Address] Avps.

Parameters:
recipientAddresses - the values corresponding to the payloads of the [Recipient-Address] Avps.

getReplyApplicId

public java.lang.String getReplyApplicId()
Gets the value corresponding to the payload of the [Reply-Applic-Id] Avp.

Returns:
the value corresponding to the payload of the [Reply-Applic-Id] Avp.

setReplyApplicId

public void setReplyApplicId(java.lang.String replyApplicId)
Sets the value corresponding to the payload of the [Reply-Applic-Id] Avp.

Parameters:
replyApplicId - the value corresponding to the payload of the [Reply-Applic-Id] Avp.

getSubmissionTime

public java.lang.Long getSubmissionTime()
Gets the value corresponding to the payload of the [Submission-Time] Avp.

Returns:
the value corresponding to the payload of the [Submission-Time] Avp.

setSubmissionTime

public void setSubmissionTime(java.lang.Long submissionTime)
Sets the value corresponding to the payload of the [Submission-Time] Avp.

Parameters:
submissionTime - the value corresponding to the payload of the [Submission-Time] Avp.

getVasId

public java.lang.String getVasId()
Gets the value corresponding to the payload of the [Vas-Id] Avp.

Returns:
the value corresponding to the payload of the [Vas-Id] Avp.

setVasId

public void setVasId(java.lang.String vasId)
Sets the value corresponding to the payload of the [Vas-Id] Avp.

Parameters:
vasId - the value corresponding to the payload of the [Vas-Id] Avp.

getVaspId

public java.lang.String getVaspId()
Gets the value corresponding to the payload of the [Vasp-Id] Avp.

Returns:
the value corresponding to the payload of the [Vasp-Id] Avp.

setVaspId

public void setVaspId(java.lang.String vaspId)
Sets the value corresponding to the payload of the [Vasp-Id] Avp.

Parameters:
vaspId - the value corresponding to the payload of the [Vasp-Id] Avp.

validate

public void validate()
              throws ChargingValidationException
Validates the members of the MMSInformation object. The charging Web Services call this method before transforming the object into a Grouped Avp. This ensures that improperly formed Avps are not sent to the Diameter peer.

Throws:
ChargingValidationException - if a member of MMSInformation is in an unexpected format.

toAvp

public Avp toAvp()
          throws AvpTransformationException
Transforms a MMSInformation object into a Grouped [MMS-Information] Avp.

All non-null members of MMSInformation will be transformed into Avps nested inside of the [MMS-Information] Avp.

Returns:
the [MMS-Information] Avp.
Throws:
AvpTransformationException - if a member of MMSInformation is in an unexpected format.


Copyright © 2006 IBM Corp. All Rights Reserved.