com.opencloud.slee.resources.mm7
Class SubmitRequestParameters

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

public final class SubmitRequestParameters
extends java.lang.Object

Container for all optional parameters related to a Submit Request.

Constructor Summary

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

Method Summary

void	addDeliveryCondition(java.lang.Integer positiveInteger) Add a delivery condition to the delivery conditions list.
void	addRecipient(Recipient recipient) Add a Recipient to the recipient list.
boolean	equals(java.lang.Object obj) Compare this object to another SubmitRequestParameters 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.
SubmitRequest.ChargedParty	getChargedParty() Get the optional charged-party parameter.
java.lang.String	getChargedPartyID() Get the optional charged party id.
javax.mail.internet.MimeBodyPart	getContent() Get the optional attached content parameter.
ContentClass	getContentClass() Get the content class.
java.lang.String	getDeliveryCondition() Get the delivery condition.
java.lang.Integer[]	getDeliveryConditions() Get the current list of delivery conditions as an array.
java.util.Collection<java.lang.Integer>	getDeliveryConditionsCollection() Get the delivery conditions list as a read-write Collection.
java.lang.Boolean	getDeliveryReporting() Get the delivery-reporting-requested flag.
java.lang.Boolean	getDistributionIndication() Get the distribution-indication flag.
java.lang.Boolean	getDRMContent() Get the DRM content - indication flag.
MM7RelativeOrAbsoluteDate	getEarliestDelivery() Get the optional earliest-delivery timestamp.
MM7RelativeOrAbsoluteDate	getExpiryDate() Get the optional expiry-date timestamp.
java.lang.String	getLinkedID() Get the optional Linked Message ID parameter.
SubmitRequest.MessageClass	getMessageClass() Get the optional message class parameter.
Priority	getPriority() Get the optional priority parameter.
java.lang.Boolean	getReadReplyReporting() Get the read-reply-reporting-requested flag.
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	getReplyApplicID() Get the reply application id of an application to which reply-MMs, delivery reports and read-reply reports are addressed.
MM7RelativeOrAbsoluteDate	getReplyChargingDeadline() Get the optional reply-charging deadline.
int	getReplyChargingSize() Get the reply-charging size.
java.lang.String	getServiceCode() Get the optional service code parametere.
java.lang.String	getSubject() Get the message subject.
java.util.Date	getTimestamp() Get the submission timestamp.
int	hashCode()
boolean	removeDeliveryCondition(java.lang.Integer positiveInteger) Remove a delivery condition from the delivery conditions list.
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.application id of destination application.
void	setChargedParty(SubmitRequest.ChargedParty chargedParty) Set the optional charged-party parameter.
void	setChargedPartyID(java.lang.String chargedPartyID) Set the optional charged party id.
void	setContent(javax.mail.internet.MimeBodyPart content, boolean allowContentAdaptation) Set the attached content parameter.
void	setContentClass(ContentClass contentClass) Set the content class.
void	setDeliveryCondition(java.lang.String deliveryCondition) Set the optional delivery condition.
void	setDeliveryReporting(java.lang.Boolean deliveryReporting) Set the delivery-reporting-requested flag.
void	setDistributionIndication(java.lang.Boolean distribution) Set the distribution-indicator flag.
void	setDRMContent(java.lang.Boolean drmContent) Set the DRM content - indicator flag.
void	setEarliestDelivery(MM7RelativeOrAbsoluteDate earliestDelivery) Set the optional earliest-delivery timestamp
void	setExpiryDate(MM7RelativeOrAbsoluteDate expiryDate) Set the optional expiry-date timestamp
void	setLinkedID(java.lang.String linkedID) Set the optional Linked Message ID parameter.
void	setMessageClass(SubmitRequest.MessageClass messageClass) Set the optional message class parameter.
void	setPriority(Priority priority) Set the optional priority parameter.
void	setReadReplyReporting(java.lang.Boolean readReplyReporting) Set the read-reply-reporting-requested flag.
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	setReplyChargingDeadline(MM7RelativeOrAbsoluteDate replyChargingDeadline) Set the optional reply-charging deadline.
void	setReplyChargingSize(int replyChargingSize) Set the reply-charging size.
void	setServiceCode(java.lang.String serviceCode) Set the optional service code parameter.
void	setSubject(java.lang.String subject) Set the message subject
void	setTimestamp(java.util.Date timestamp) Set the submission timestamp.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SubmitRequestParameters

public SubmitRequestParameters()

Construct a new object with no optional parameters set.

Method Detail

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

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

setServiceCode

public void setServiceCode(java.lang.String serviceCode)

Set the optional service code parameter.

Parameters:

serviceCode - the new service code, or null to clear the service code

getServiceCode

public java.lang.String getServiceCode()

Get the optional service code parametere.

Returns:

the service code, or null if not set

setMessageClass

public void setMessageClass(SubmitRequest.MessageClass messageClass)

Set the optional message class parameter.

Parameters:

messageClass - the new message class, or null to clear the message class

getMessageClass

public SubmitRequest.MessageClass getMessageClass()

Get the optional message class parameter.

Returns:

the message class, or null if not present

getTimestamp

public java.util.Date getTimestamp()

Get the submission timestamp.

Returns:

the timestamp, or null if not set

setTimestamp

public void setTimestamp(java.util.Date timestamp)

Set the submission timestamp.

Parameters:

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

setReplyChargingSize

public void setReplyChargingSize(int replyChargingSize)

Set the reply-charging size.

Parameters:

replyChargingSize - the maximum allowable reply, or 0 to disable

getReplyChargingSize

public int getReplyChargingSize()

Get the reply-charging size.

Returns:

the reply-charging size, or 0 if disabled

setReplyChargingDeadline

public void setReplyChargingDeadline(MM7RelativeOrAbsoluteDate replyChargingDeadline)

Set the optional reply-charging deadline.

Parameters:

replyChargingDeadline - the new deadline, or null to clear the deadline.

getReplyChargingDeadline

public MM7RelativeOrAbsoluteDate getReplyChargingDeadline()

Get the optional reply-charging deadline.

Returns:

the deadline, or null if not set.

setEarliestDelivery

public void setEarliestDelivery(MM7RelativeOrAbsoluteDate earliestDelivery)

Set the optional earliest-delivery timestamp

Parameters:

earliestDelivery - the new timestamp, or null to clear the timestamp.

getEarliestDelivery

public MM7RelativeOrAbsoluteDate getEarliestDelivery()

Get the optional earliest-delivery timestamp.

Returns:

the timestamp, or null if not set.

setExpiryDate

public void setExpiryDate(MM7RelativeOrAbsoluteDate expiryDate)

Set the optional expiry-date timestamp

Parameters:

expiryDate - the new timestamp, or null to clear the timestamp.

getExpiryDate

public MM7RelativeOrAbsoluteDate getExpiryDate()

Get the optional expiry-date timestamp.

Returns:

the timestamp, or null if not set.

setDeliveryReporting

public void setDeliveryReporting(java.lang.Boolean deliveryReporting)

Set the delivery-reporting-requested flag.

Parameters:

deliveryReporting - the new flag value, or null if not set

getDeliveryReporting

public java.lang.Boolean getDeliveryReporting()

Get the delivery-reporting-requested flag.

Returns:

the flag's value, or null if not set

setReadReplyReporting

public void setReadReplyReporting(java.lang.Boolean readReplyReporting)

Set the read-reply-reporting-requested flag.

Parameters:

readReplyReporting - the new flag value, or null if not set

getReadReplyReporting

public java.lang.Boolean getReadReplyReporting()

Get the read-reply-reporting-requested flag.

Returns:

the flag's value, or null if not set

setPriority

public void setPriority(Priority priority)

Set the optional priority parameter.

Parameters:

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

getPriority

public Priority getPriority()

Get the optional 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

setChargedParty

public void setChargedParty(SubmitRequest.ChargedParty chargedParty)

Set the optional charged-party parameter.

Parameters:

chargedParty - the new charged party, or null to clear the charged party

getChargedParty

public SubmitRequest.ChargedParty getChargedParty()

Get the optional charged-party parameter.

Returns:

the charged party, or null if not present

setChargedPartyID

public void setChargedPartyID(java.lang.String chargedPartyID)

Set the optional charged party id.

Parameters:

chargedPartyID - the new charged party id, or null to clear the charged party id

Since:

MM7 v.6.3.0

getChargedPartyID

public java.lang.String getChargedPartyID()

Get the optional charged party id.

Returns:

the charged party id, or null if not present

Since:

MM7 v.6.3.0

setDistributionIndication

public void setDistributionIndication(java.lang.Boolean distribution)

Set the distribution-indicator flag.

Parameters:

distribution - the new value of the flag, or null if not set

getDistributionIndication

public java.lang.Boolean getDistributionIndication()

Get the distribution-indication flag.

Returns:

the value of the flag, or null if not set

setDeliveryCondition

public void setDeliveryCondition(java.lang.String deliveryCondition)

Set the optional delivery condition. Relevant when using REL-6-MM7-1-3 schema.

Parameters:

deliveryCondition - the new value of the deliveryCondition, or null if not set

getDeliveryCondition

public java.lang.String getDeliveryCondition()

Get the delivery condition. Relevant when using REL-6-MM7-1-3 schema.

Returns:

the value of the delivery condition, or null if not set

addDeliveryCondition

public void addDeliveryCondition(java.lang.Integer positiveInteger)

Add a delivery condition to the delivery conditions list. Relevant when using REL-6-MM7-1-4 schema.

Parameters:

positiveInteger - the delivery condition to add

Throws:

java.lang.IllegalArgumentException - if positiveInteger is not positive (positive integer is Integer > 0)

Since:

MM7 v.6.6.0

removeDeliveryCondition

public boolean removeDeliveryCondition(java.lang.Integer positiveInteger)

Remove a delivery condition from the delivery conditions list. Relevant when using REL-6-MM7-1-4 schema.

Parameters:

positiveInteger - the delivery condition to remove

Returns:

true if the delivery condition was present (before removal)

Since:

MM7 v.6.6.0

getDeliveryConditionsCollection

public java.util.Collection<java.lang.Integer> getDeliveryConditionsCollection()

Get the delivery conditions list as a read-write Collection. Modifications to the returned Collection are reflected in the delivery conditions list of the parameters object. Relevant when using REL-6-MM7-1-4 schema. Added Delivery conditions must be positive integers (> 0).

Returns:

a Collection of Integer objects

Since:

MM7 v.6.6.0

getDeliveryConditions

public java.lang.Integer[] getDeliveryConditions()

Get the current list of delivery conditions as an array. This is a snapshot of the delivery conditions list state. Relevant when using REL-6-MM7-1-4 schema.

Returns:

a non-null array of Integer objects

Since:

MM7 v.6.6.0

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.application id of destination application.

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

setContentClass

public void setContentClass(ContentClass contentClass)

Set the content class.

Parameters:

contentClass - the content class value, or null to clear

Since:

MM7 v.6.8.0

getContentClass

public ContentClass getContentClass()

Get the content class.

Returns:

content class, or null if not set

Since:

MM7 v.6.8.0

setDRMContent

public void setDRMContent(java.lang.Boolean drmContent)

Set the DRM content - indicator flag.

Parameters:

drmContent - the new value of the flag, or null if not set

Since:

MM7 v.6.8.0

getDRMContent

public java.lang.Boolean getDRMContent()

Get the DRM content - indication flag.

Returns:

the value of the flag, or null if not set

Since:

MM7 v.6.8.0

setContent

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

Set the attached content parameter.

Parameters:

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

allowContentAdaptation - if true, allow content adaptation

getContent

public javax.mail.internet.MimeBodyPart getContent()

Get the optional attached content parameter.

Returns:

the attached content, or null if not present

getAllowContentAdaptation

public boolean getAllowContentAdaptation()

Get the allow-content-adaptation flag.

Returns:

the value of the flag

equals

public boolean equals(java.lang.Object obj)

Compare this object to another SubmitRequestParameters 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