com.opencloud.slee.resources.mm7
Interface SubmitRequest

All Superinterfaces:
Request, VASPRequest

public interface SubmitRequest
extends VASPRequest

Represents an incoming Submit Request from the peer VASP.


Nested Class Summary
static class SubmitRequest.ChargedParty
          Enum for Submit 'charged party' values.
static class SubmitRequest.MessageClass
          Enum for Submit message classes.
 
Method Summary
 boolean getAllowContentAdaptation()
          Get the allow-content-adaptation flag of this request.
 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 of this request.
 java.lang.String getChargedPartyID()
          Get the optional charged party id.
 javax.mail.internet.MimeBodyPart getContent()
          Get the optional attached content of this request.
 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.lang.Boolean getDeliveryReporting()
          Get the optional delivery-reporting-requested flag of this request.
 java.lang.Boolean getDistributionIndication()
          Get the optional distribution-indicator flag of this request.
 java.lang.Boolean getDRMContent()
          Get the DRM content - indication flag.
 MM7RelativeOrAbsoluteDate getEarliestDelivery()
          Get the optional earliest-delivery timestamp of this request.
 MM7RelativeOrAbsoluteDate getExpiryDate()
          Get the optional expiry-date timestamp of this request.
 java.lang.String getLinkedID()
          Get the optional linked message ID of this request.
 SubmitRequest.MessageClass getMessageClass()
          Get the optional message class of this request.
 Priority getPriority()
          Get the optional priority of this request.
 java.lang.Boolean getReadReplyReporting()
          Get the optional read-reply-reporting-requested flag of this request.
 Recipient[] getRecipients()
          Get the recipient list for this request.
 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 of this request.
 int getReplyChargingSize()
          Get the optional reply-charging size of this request.
 java.lang.String getServiceCode()
          Get the optional service code of this request.
 java.lang.String getSubject()
          Get the optional subject of this request.
 java.util.Date getTimestamp()
          Get the optional timestamp of this request.
 
Methods inherited from interface com.opencloud.slee.resources.mm7.VASPRequest
getSenderID
 
Methods inherited from interface com.opencloud.slee.resources.mm7.Request
getMM7Version
 

Method Detail

getRecipients

Recipient[] getRecipients()
Get the recipient list for this request.

Returns:
a non-null array of recipients

getServiceCode

java.lang.String getServiceCode()
Get the optional service code of this request.

Returns:
the service code, or null if not present

getLinkedID

java.lang.String getLinkedID()
Get the optional linked message ID of this request.

Returns:
the linked message ID, or null if not present

getMessageClass

SubmitRequest.MessageClass getMessageClass()
Get the optional message class of this request.

Returns:
the message class, or null if not present

getTimestamp

java.util.Date getTimestamp()
Get the optional timestamp of this request.

Returns:
the timestamp, or null if not present

getReplyChargingSize

int getReplyChargingSize()
Get the optional reply-charging size of this request.

Returns:
the reply-charging size, or 0 if not present

getReplyChargingDeadline

MM7RelativeOrAbsoluteDate getReplyChargingDeadline()
Get the optional reply-charging deadline of this request.

Returns:
the reply-charging deadline, or null if not present

getEarliestDelivery

MM7RelativeOrAbsoluteDate getEarliestDelivery()
Get the optional earliest-delivery timestamp of this request.

Returns:
the earliest-delivery timestamp, or null if not present

getExpiryDate

MM7RelativeOrAbsoluteDate getExpiryDate()
Get the optional expiry-date timestamp of this request.

Returns:
the expiry-date timestamp, or null if not present

getDeliveryReporting

java.lang.Boolean getDeliveryReporting()
Get the optional delivery-reporting-requested flag of this request.

Returns:
the flag's value, or null if not present

getReadReplyReporting

java.lang.Boolean getReadReplyReporting()
Get the optional read-reply-reporting-requested flag of this request.

Returns:
the flag's value, or null if not present

getPriority

Priority getPriority()
Get the optional priority of this request.

Returns:
the priority, or null if not present

getSubject

java.lang.String getSubject()
Get the optional subject of this request.

Returns:
the subject, or null if not present

getChargedParty

SubmitRequest.ChargedParty getChargedParty()
Get the optional charged-party of this request.

Returns:
the charged party, or null if not present

getChargedPartyID

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

getDistributionIndication

java.lang.Boolean getDistributionIndication()
Get the optional distribution-indicator flag of this request.

Returns:
the flag's value, or null if not present

getDeliveryCondition

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

getDeliveryConditions

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 (should be positive integers > 0)
Since:
MM7 v.6.6.0

getApplicID

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

getReplyApplicID

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

getAuxApplicInfo

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

getDRMContent

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

getContentClass

ContentClass getContentClass()
Get the content class.

Returns:
content class, or null if not set
Since:
MM7 v. 6.8.0

getContent

javax.mail.internet.MimeBodyPart getContent()
Get the optional attached content of this request.

Returns:
the attached content, or null if not present

getAllowContentAdaptation

boolean getAllowContentAdaptation()
Get the allow-content-adaptation flag of this request.

Returns:
the flag's value