com.opencloud.slee.resources.mm7
Class DeliverRequestParameters

java.lang.Object
  com.opencloud.slee.resources.mm7.DeliverRequestParameters

public final class DeliverRequestParameters
extends java.lang.Object

Container for all optional parameters related to a Deliver Request.

Constructor Summary

DeliverRequestParameters()
Construct a new object with no optional parameters set.

Method Summary

void	addPreviouslySentByUA(UserAgentInfo userAgentInfo) Add a UserAgentInfo to the list of forwarding User Agents.
void	addPreviouslySentDateAndTime(UserAgentRelativeOrAbsoluteDate userAgentRelativeOrAbsoluteDate) Add a UserAgentRelativeOrAbsoluteDate to the list of date and times associated with previous submission and forward events of the MM.
void	addRecipient(Recipient recipient) Add a Recipient to the recipient list.
boolean	equals(java.lang.Object obj) Compare this object to another DeliverRequestParameters object.
boolean	getAllowContentAdaptation() Get the allow-content-adaptation flag
java.lang.String	getApplicID() Get the application id of destination application.
java.lang.String	getAuxApplicInfo() Get the auxiliary application addressing information.
javax.mail.internet.MimeBodyPart	getContent() Get the message attachment content.
java.lang.String	getLinkedID() Get the optional Linked Message ID parameter.
UserAgentInfo[]	getPreviouslySentByUAs() Get the current list of forwarding User Agents as an array.
java.util.Collection<UserAgentInfo>	getPreviouslySentByUAsCollection() Get the list of forwarding User Agents as a read-write Collection.
UserAgentRelativeOrAbsoluteDate[]	getPreviouslySentDatesAndTimes() Get the current list of date and times associated with previous submission and forward events of the MM.
java.util.Collection<UserAgentRelativeOrAbsoluteDate>	getPreviouslySentDatesAndTimesCollection() Get the list of date and times associated with previous submission and forward events of the MM as a read-write Collection.
Priority	getPriority() Get the message priority parameter
Recipient[]	getRecipients() Get the current list of recipients as an array.
java.util.Collection<Recipient>	getRecipientsCollection() Get the recipient list as a read-write Collection.
java.lang.String	getRecipientSPI() Get the recipient SPI.
java.lang.String	getReplyApplicID() Get the reply application id of an application to which reply-MMs, delivery reports and read-reply reports are addressed.
java.lang.String	getReplyChargingID() Get the reply charging ID parameter.
java.lang.String	getSenderSPI() Get the sender SPI.
java.lang.String	getSubject() Get the message subject.
java.util.Date	getTimestamp() Get the delivery timestamp.
UACapabilities	getUACapabilities() Get the UA capabilities.
java.lang.String	getVASID() Get the optional VAS ID parameter.
java.lang.String	getVASPID() Get the optional VASP ID parameter.
int	hashCode()
boolean	removePreviouslySentByUA(UserAgentInfo userAgentInfo) Remove a UserAgentInfo from the list of forwarding User Agents.
boolean	removePreviouslySentDateAndTime(UserAgentRelativeOrAbsoluteDate userAgentRelativeOrAbsoluteDate) Remove a UserAgentRelativeOrAbsoluteDate from the list of date and times associated with previous submission and forward events of the MM.
boolean	removeRecipient(Recipient recipient) Remove a Recipient from the recipient list.
void	setApplicID(java.lang.String applicID) Set the application id of destination application.
void	setAuxApplicInfo(java.lang.String auxApplicInfo) Set the auxiliary application addressing information.
void	setContent(javax.mail.internet.MimeBodyPart content, boolean allowContentAdaptation) Set the message attachment content.
void	setLinkedID(java.lang.String linkedID) Set the optional Linked Message ID parameter.
void	setPriority(Priority priority) Set the message priority parameter.
void	setRecipientSPI(java.lang.String recipientSPI) Set the recipient SPI.
void	setReplyApplicID(java.lang.String replyApplicID) Set the reply application id of an application to which reply-MMs, delivery reports and read-reply reports are addressed.
void	setReplyChargingID(java.lang.String replyChargingID) Set the reply charging ID parameter.
void	setSenderSPI(java.lang.String senderSPI) Set the sender SPI.
void	setSubject(java.lang.String subject) Set the message subject
void	setTimestamp(java.util.Date timestamp) Set the delivery timestamp.
void	setUACapabilities(UACapabilities uaCapabilities) Set the UA capabilities.
void	setVASID(java.lang.String vasID) Set the optional VAS ID parameter.
void	setVASPID(java.lang.String vaspID) Set the optional VASP ID parameter.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeliverRequestParameters

public DeliverRequestParameters()

Construct a new object with no optional parameters set.

Method Detail

setVASPID

public void setVASPID(java.lang.String vaspID)

Set the optional VASP ID parameter.

Parameters:

vaspID - the new value, or null to clear the VASP ID

Since:

MM7 v.6.8.0

getVASPID

public java.lang.String getVASPID()

Get the optional VASP ID parameter.

Returns:

the VASP ID, or null if not set

Since:

MM7 v.6.8.0

setVASID

public void setVASID(java.lang.String vasID)

Set the optional VAS ID parameter.

Parameters:

vasID - the new value, or null to clear the VAS ID

Since:

MM7 v.6.8.0

getVASID

public java.lang.String getVASID()

Get the optional VAS ID parameter.

Returns:

the VAS ID, or null if not set

Since:

MM7 v.6.8.0

setLinkedID

public void setLinkedID(java.lang.String linkedID)

Set the optional Linked Message ID parameter.

Parameters:

linkedID - the new value, or null to clear the linked ID

getLinkedID

public java.lang.String getLinkedID()

Get the optional Linked Message ID parameter.

Returns:

the linked ID, or null if not set

addRecipient

public void addRecipient(Recipient recipient)

Add a Recipient to the recipient list.

Parameters:

recipient - the recipient to add

removeRecipient

public boolean removeRecipient(Recipient recipient)

Remove a Recipient from the recipient list.

Parameters:

recipient - the recipient to remove

Returns:

true if the recipient was present (before removal)

getRecipientsCollection

public java.util.Collection<Recipient> getRecipientsCollection()

Get the recipient list as a read-write Collection. Modifications to the returned Collection are reflected in the recipient list of the parameters object.

Returns:

a Collection of Recipient objects

getRecipients

public Recipient[] getRecipients()

Get the current list of recipients as an array. This is a snapshot of the recipient list state.

Returns:

a non-null array of Recipient objects

addPreviouslySentByUA

public void addPreviouslySentByUA(UserAgentInfo userAgentInfo)

Add a UserAgentInfo to the list of forwarding User Agents.

Parameters:

userAgentInfo - the User Agent information to add

Since:

MM7 v.6.3.0

removePreviouslySentByUA

public boolean removePreviouslySentByUA(UserAgentInfo userAgentInfo)

Remove a UserAgentInfo from the list of forwarding User Agents.

Parameters:

userAgentInfo - the User Agent information to remove

Returns:

true if the userAgentInfo was present (before removal)

Since:

MM7 v.6.3.0

getPreviouslySentByUAsCollection

public java.util.Collection<UserAgentInfo> getPreviouslySentByUAsCollection()

Get the list of forwarding User Agents as a read-write Collection. Modifications to the returned Collection are reflected in the fowarding user agents list of the parameters object.

Returns:

a Collection of UserAgentInfo objects

Since:

MM7 v.6.3.0

getPreviouslySentByUAs

public UserAgentInfo[] getPreviouslySentByUAs()

Get the current list of forwarding User Agents as an array. This is a snapshot of the forwarding User Agents list state.

Returns:

a non-null array of UserAgentInfo objects

Since:

MM7 v.6.3.0

addPreviouslySentDateAndTime

public void addPreviouslySentDateAndTime(UserAgentRelativeOrAbsoluteDate userAgentRelativeOrAbsoluteDate)

Add a UserAgentRelativeOrAbsoluteDate to the list of date and times associated with previous submission and forward events of the MM.

Parameters:

userAgentRelativeOrAbsoluteDate - the date and time information to add

Since:

MM7 v.6.3.0

removePreviouslySentDateAndTime

public boolean removePreviouslySentDateAndTime(UserAgentRelativeOrAbsoluteDate userAgentRelativeOrAbsoluteDate)

Remove a UserAgentRelativeOrAbsoluteDate from the list of date and times associated with previous submission and forward events of the MM.

Parameters:

mm7RelativeOrAbsoluteDate - the date and time information to remove

Returns:

true if the userAgentRelativeOrAbsoluteDate was present (before removal)

Since:

MM7 v.6.3.0

getPreviouslySentDatesAndTimesCollection

public java.util.Collection<UserAgentRelativeOrAbsoluteDate> getPreviouslySentDatesAndTimesCollection()

Get the list of date and times associated with previous submission and forward events of the MM as a read-write Collection. Modifications to the returned Collection are reflected in the previously sent date and times list of the parameters object.

Returns:

a Collection of UserAgentRelativeOrAbsoluteDate objects

Since:

MM7 v.6.3.0

getPreviouslySentDatesAndTimes

public UserAgentRelativeOrAbsoluteDate[] getPreviouslySentDatesAndTimes()

Get the current list of date and times associated with previous submission and forward events of the MM. This is a snapshot of the previously sent date and times list state.

Returns:

a non-null array of UserAgentRelativeOrAbsoluteDate objects

Since:

MM7 v.6.3.0

getSenderSPI

public java.lang.String getSenderSPI()

Get the sender SPI.

Returns:

the sender SPI, or null if not set

Since:

MM7 v.6.3.0

setSenderSPI

public void setSenderSPI(java.lang.String senderSPI)

Set the sender SPI.

Parameters:

senderSPI - the new sender SPI to set, or null to clear the sender SPI

Since:

MM7 v.6.3.0

getRecipientSPI

public java.lang.String getRecipientSPI()

Get the recipient SPI.

Returns:

the recipient SPI, or null if not set

Since:

MM7 v.6.3.0

setRecipientSPI

public void setRecipientSPI(java.lang.String recipientSPI)

Set the recipient SPI.

Parameters:

recipientSPI - the new recipient SPI to set, or null to clear the recipient SPI

Since:

MM7 v.6.3.0

getTimestamp

public java.util.Date getTimestamp()

Get the delivery timestamp.

Returns:

the timestamp, or null if not set

setTimestamp

public void setTimestamp(java.util.Date timestamp)

Set the delivery timestamp.

Parameters:

timestamp - the new timestamp to set, or null to clear the timestamp

setReplyChargingID

public void setReplyChargingID(java.lang.String replyChargingID)

Set the reply charging ID parameter.

Parameters:

replyChargingID - the reply charging ID to set, or null to clear the ID

getReplyChargingID

public java.lang.String getReplyChargingID()

Get the reply charging ID parameter.

Returns:

the reply charging ID, or null if not present

setPriority

public void setPriority(Priority priority)

Set the message priority parameter.

Parameters:

priority - the new priority, or null to clear the priority

getPriority

public Priority getPriority()

Get the message priority parameter

Returns:

the priority, or null if not present

setSubject

public void setSubject(java.lang.String subject)

Set the message subject

Parameters:

subject - the subject to set, or null to clear the subject

getSubject

public java.lang.String getSubject()

Get the message subject.

Returns:

the message subject, or null if not present

setApplicID

public void setApplicID(java.lang.String applicID)

Set the application id of destination application.

Parameters:

applicID - the new application id value, or null to clear

Since:

MM7 v.6.8.0

getApplicID

public java.lang.String getApplicID()

Get the application id of destination application.

Returns:

application id, or null if not set

Since:

MM7 v.6.8.0

setReplyApplicID

public void setReplyApplicID(java.lang.String replyApplicID)

Set the reply application id of an application to which reply-MMs, delivery reports and read-reply reports are addressed.

Parameters:

replyApplicID - the new reply application id value, or null to clear

Since:

MM7 v.6.8.0

getReplyApplicID

public java.lang.String getReplyApplicID()

Get the reply application id of an application to which reply-MMs, delivery reports and read-reply reports are addressed.

Returns:

reply application id, or null if not set

Since:

MM7 v.6.8.0

setAuxApplicInfo

public void setAuxApplicInfo(java.lang.String auxApplicInfo)

Set the auxiliary application addressing information.

Parameters:

auxApplicInfo - the new auxiliary application information value, or null to clear

Since:

MM7 v.6.8.0

getAuxApplicInfo

public java.lang.String getAuxApplicInfo()

Get the auxiliary application addressing information.

Returns:

auxiliary application information, or null if not set

Since:

MM7 v.6.8.0

setUACapabilities

public void setUACapabilities(UACapabilities uaCapabilities)

Set the UA capabilities.

Parameters:

uaCapabilities - the new UA capabilities value, or null to clear

Since:

MM7 v.6.8.0

getUACapabilities

public UACapabilities getUACapabilities()

Get the UA capabilities.

Returns:

UA capabilities, or null if not set

Since:

MM7 v.6.8.0

setContent

public void setContent(javax.mail.internet.MimeBodyPart content,
                       boolean allowContentAdaptation)

Set the message attachment content.

Parameters:

content - the attachment content, or null to clear the attachment content

allowContentAdaptation - if true, allow adaptation of the attached content

getContent

public javax.mail.internet.MimeBodyPart getContent()

Get the message attachment content.

Returns:

the attached content, or null if not present

getAllowContentAdaptation

public boolean getAllowContentAdaptation()

Get the allow-content-adaptation flag

Returns:

true if the attached content may be adapted

equals

public boolean equals(java.lang.Object obj)

Compare this object to another DeliverRequestParameters object. Content is compared based on content IDs only.

Overrides:

equals in class java.lang.Object

Returns:

true if the two objects are equal

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object