Interface MessagingManager

All Superinterfaces:

AutoCloseable, Closeable, MessagingProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface MessagingManager
extends OsidManager, MessagingProfile

The message manager provides access to message lookup and creation sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• MessagingSession : a session to send messages
• MessageLookupSession : a session to retrieve messages
• MessageQuerySession : a session to query for messages
• MessageSearchSession : a session to search for messages
• MessageAdminSession : a session to create and delete messages
• MessageNotificationSession : a session to receive notifications pertaining to message changes
• MessageMailboxSession : a session to look up message to mailbox mappings
• MessageMailboxAssignmentSession : a session to manage message to mailbox mappings
• MessageSmartMailboxSession : a session to manage dynamic mailboxes of messages

• ReceiptLookupSession: a session to retrieve message receipts
• ReceiptAdminSession : a session to update message receipts
• ReceiptNotificationSession : a session to receive notifications pertaining to changes in message receipts

• MailboxLookupSession: a session to retrieve mailboxes
• MailboxQuerySession : a session to query mailboxes
• MailboxSearchSession : a session to search for mailboxes
• MailboxAdminSession : a session to create, update and delete mailboxes
• MailboxNotificationSession : a session to receive notifications pertaining to changes in mailboxes
• MailboxHierarchySession : a session to traverse mailbox hierarchies
• MailboxHierarchyDesignSession : a session to manage mailbox hierarchies

Method Summary

Modifier and Type	Method	Description
MailboxAdminSession	getMailboxAdminSession()	Gets the mailbox administrative session for creating, updating and deleteing mailboxes.
MailboxHierarchyDesignSession	getMailboxHierarchyDesignSession()	Gets the mailbox hierarchy design session.
MailboxHierarchySession	getMailboxHierarchySession()	Gets the mailbox hierarchy traversal session.
MailboxLookupSession	getMailboxLookupSession()	Gets the mailbox lookup session.
MailboxNotificationSession	getMailboxNotificationSession(MailboxReceiver mailboxReceiver)	Gets the notification session for subscribing to changes to a mailbox.
MessageQuerySession	getMailboxQuerySession()	Gets the mailbox query session.
MailboxSearchSession	getMailboxSearchSession()	Gets the mailbox search session.
MessageAdminSession	getMessageAdminSession()	Gets a message administration session for creating, updating and deleting messages.
MessageAdminSession	getMessageAdminSessionForMailbox(Id mailboxId)	Gets a message administration session for the given mailbox.
MessageLookupSession	getMessageLookupSession()	Gets the OsidSession associated with the message lookup service.
MessageLookupSession	getMessageLookupSessionForMailbox(Id mailboxId)	Gets the OsidSession associated with the message lookup service for the given mailbox.
MessageMailboxAssignmentSession	getMessageMailboxAssignmentSession()	Gets the session for assigning message to mailbox mappings.
MessageMailboxSession	getMessageMailboxSession()	Gets the session for retrieving message to mailbox mappings.
MessageNotificationSession	getMessageNotificationSession(MessageReceiver messageReceiver)	Gets the notification session for notifications pertaining to message changes.
MessageNotificationSession	getMessageNotificationSessionForMailbox(MessageReceiver messageReceiver, Id mailboxId)	Gets the message notification session for the given mailbox.
MessageQuerySession	getMessageQuerySession()	Gets the OsidSession associated with the message query service.
MessageQuerySession	getMessageQuerySessionForMailbox(Id mailboxId)	Gets the OsidSession associated with the message query service for the given mailbox.
MessageSearchSession	getMessageSearchSession()	Gets a message search session.
MessageSearchSession	getMessageSearchSessionForMailbox(Id mailboxId)	Gets a message search session for the given mailbox.
MessageSmartMailboxSession	getMessageSmartMailboxSession(Id mailboxId)	Gets the OsidSession to manage locatin smart mailboxes.
MessagingBatchManager	getMessagingBatchManager()	Gets a MessagingBatchManager .
MessagingSession	getMessagingSession()	Gets the OsidSession associated with the message sending.
ReceiptAdminSession	getReceiptAdminSession()	Gets the OsidSession associated with the receipt administrative service.
ReceiptAdminSession	getReceiptAdminSessionForMailbox(Id mailboxId)	Gets the OsidSession associated with the receipt administrative service for the given mailbox.
ReceiptLookupSession	getReceiptLookupSession()	Gets the OsidSession associated with the receipt lookup service.
ReceiptLookupSession	getReceiptLookupSessionForMailbox(Id mailboxId)	Gets the OsidSession associated with the receipt lookup service for the given mailbox.
ReceiptNotificationSession	getReceiptNotificationSession(ReceiptReceiver receiptReceiver)	Gets the notification session for notifications pertaining to receipt changes.
ReceiptNotificationSession	getReceiptNotificationSessionForMailbox(ReceiptReceiver receiptReceiver, Id mailboxId)	Gets the receipt notification session for the given mailbox.

Methods inherited from interface Closeable

close

Methods inherited from interface MessagingProfile

getMailboxRecordTypes, getMailboxSearchRecordTypes, getMessageRecordTypes, getMessageSearchRecordTypes, getReceiptRecordTypes, supportsMailboxAdmin, supportsMailboxHierarchy, supportsMailboxHierarchyDesign, supportsMailboxLookup, supportsMailboxNotification, supportsMailboxRecordType, supportsMailboxSearch, supportsMailboxSearchRecordType, supportsMessageAdmin, supportsMessageLookup, supportsMessageMailbox, supportsMessageMailboxAssignment, supportsMessageNotification, supportsMessageQuery, supportsMessageRecordType, supportsMessageSearch, supportsMessageSearchRecordType, supportsMessageSmartMailbox, supportsMessaging, supportsMessagingBatch, supportsReceiptAdmin, supportsReceiptLookup, supportsReceiptNotification, supportsReceiptRecordType, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getMailboxRecordTypes()	Gets all the mailbox record types supported.
TypeList	getMailboxSearchRecordTypes()	Gets all the mailbox search record types supported.
TypeList	getMessageRecordTypes()	Gets all the message record types supported.
TypeList	getMessageSearchRecordTypes()	Gets all the message search record types supported.
TypeList	getReceiptRecordTypes()	Gets all the receipt record types supported.
boolean	supportsMailboxAdmin()	Tests if mailbox administration is supported.
boolean	supportsMailboxHierarchy()	Tests if a mailbox hierarchy traversal is supported.
boolean	supportsMailboxHierarchyDesign()	Tests if a mailbox hierarchy design is supported.
boolean	supportsMailboxLookup()	Tests if mailbox lookup is supported.
boolean	supportsMailboxNotification()	Tests if mailbox notification is supported.
boolean	supportsMailboxRecordType(Type mailboxRecordType)	Tests if a given mailbox record type is supported.
boolean	supportsMailboxSearch()	Tests if mailbox search is supported.
boolean	supportsMailboxSearchRecordType(Type mailboxSearchRecordType)	Tests if a given mailbox search record type is supported.
boolean	supportsMessageAdmin()	Tests if creating, updating and deleting messages is supported.
boolean	supportsMessageLookup()	Tests if message lookup is supported.
boolean	supportsMessageMailbox()	Tests if retrieving mappings of message and mailboxes is supported.
boolean	supportsMessageMailboxAssignment()	Tests if managing mappings of messages and mailboxes is supported.
boolean	supportsMessageNotification()	Tests if message notification is supported.
boolean	supportsMessageQuery()	Tests if querying messages is supported.
boolean	supportsMessageRecordType(Type messageRecordType)	Tests if a given message record type is supported.
boolean	supportsMessageSearch()	Tests if message search is supported.
boolean	supportsMessageSearchRecordType(Type messageSearchRecordType)	Tests if a given message search type is supported.
boolean	supportsMessageSmartMailbox()	Tests if a messaging smart mailbox service is supported.
boolean	supportsMessaging()	Tests if sending messages is supported.
boolean	supportsMessagingBatch()	Tests if a messaging batch service is supported.
boolean	supportsReceiptAdmin()	Tests if updating receipts is supported.
boolean	supportsReceiptLookup()	Tests if receipt lookup is supported.
boolean	supportsReceiptNotification()	Tests if receipts notification is supported.
boolean	supportsReceiptRecordType(Type receiptRecordType)	Tests if a given receipt record type is supported.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getMessagingSession

MessagingSession getMessagingSession()
                              throws OperationFailedException

Gets the OsidSession associated with the message sending.

Returns:

a MessagingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMessaging() is false

Compliance:

optional - This method must be implemented if {@code supportsMessaging()} is {@code true} .

getMessageLookupSession

MessageLookupSession getMessageLookupSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the message lookup service.

Returns:

a MessageLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsMessageLookup()} is {@code true} .

getMessageLookupSessionForMailbox

MessageLookupSession getMessageLookupSessionForMailbox(Id mailboxId)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the message lookup service for the given mailbox.

Parameters:

mailboxId - the Id of the mailbox

Returns:

a MessageLookupSession

Throws:

NotFoundException - mailboxId not found

NullArgumentException - mailboxId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsMessageLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getMessageQuerySession

MessageQuerySession getMessageQuerySession()
                                    throws OperationFailedException

Gets the OsidSession associated with the message query service.

Returns:

a MessageQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsMessageQuery()} is {@code true} .

getMessageQuerySessionForMailbox

MessageQuerySession getMessageQuerySessionForMailbox(Id mailboxId)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the message query service for the given mailbox.

Parameters:

mailboxId - the Id of the Mailbox

Returns:

a MessageQuerySession

Throws:

NotFoundException - no mailbox found by the given Id

NullArgumentException - mailboxId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsMessageQuery()} and {@code supportsVisibleFederation()} are {@code true}

getMessageSearchSession

MessageSearchSession getMessageSearchSession()
                                      throws OperationFailedException

Gets a message search session.

Returns:

a MessageSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsMessageSearch()} is {@code true} .

getMessageSearchSessionForMailbox

MessageSearchSession getMessageSearchSessionForMailbox(Id mailboxId)
                                                throws NotFoundException,
OperationFailedException

Gets a message search session for the given mailbox.

Parameters:

mailboxId - the Id of the mailbox

Returns:

a MessageSearchSession

Throws:

NotFoundException - mailboxId not found

NullArgumentException - mailboxId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsMessageSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getMessageAdminSession

MessageAdminSession getMessageAdminSession()
                                    throws OperationFailedException

Gets a message administration session for creating, updating and deleting messages.

Returns:

a MessageAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsMessageAdmin()} is {@code true} .

getMessageAdminSessionForMailbox

MessageAdminSession getMessageAdminSessionForMailbox(Id mailboxId)
                                              throws NotFoundException,
OperationFailedException

Gets a message administration session for the given mailbox.

Parameters:

mailboxId - the Id of the mailbox

Returns:

a MessageAdminSession

Throws:

NotFoundException - mailboxId not found

NullArgumentException - mailboxId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsMessageAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getMessageNotificationSession

MessageNotificationSession getMessageNotificationSession(MessageReceiver messageReceiver)
                                                  throws OperationFailedException

Gets the notification session for notifications pertaining to message changes.

Parameters:

messageReceiver - the notification callback

Returns:

a MessageNotificationSession

Throws:

NullArgumentException - messageReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsMessageNotification()} is {@code true} .

getMessageNotificationSessionForMailbox

MessageNotificationSession getMessageNotificationSessionForMailbox(MessageReceiver messageReceiver,
 Id mailboxId)
                                                            throws NotFoundException,
OperationFailedException

Gets the message notification session for the given mailbox.

Parameters:

messageReceiver - the notification callback

mailboxId - the Id of the mailbox

Returns:

a MessageNotificationSession

Throws:

NotFoundException - mailboxId not found

NullArgumentException - messageReceiver or mailboxId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsMessageNotfication()} and {@code supportsVisibleFederation()} are {@code true} .

getMessageMailboxSession

MessageMailboxSession getMessageMailboxSession()
                                        throws OperationFailedException

Gets the session for retrieving message to mailbox mappings.

Returns:

a MessageMailboxSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageMailbox() is false

Compliance:

optional - This method must be implemented if {@code supportsMessageMailbox()} is {@code true} .

getMessageMailboxAssignmentSession

MessageMailboxAssignmentSession getMessageMailboxAssignmentSession()
                                                            throws OperationFailedException

Gets the session for assigning message to mailbox mappings.

Returns:

a MessageMailboxAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageMailboxAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsMessageMailboxAssignment()} is {@code true} .

getMessageSmartMailboxSession

MessageSmartMailboxSession getMessageSmartMailboxSession(Id mailboxId)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage locatin smart mailboxes.

Parameters:

mailboxId - the Id of the mailbox

Returns:

a MessageSmartMailboxSession

Throws:

NotFoundException - mailboxId not found

NullArgumentException - mailboxId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageSmartMailbox() is false

Compliance:

optional - This method must be implemented if {@code supportsMessageSmartMailbox()} is {@code true} .

getReceiptLookupSession

ReceiptLookupSession getReceiptLookupSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the receipt lookup service.

Returns:

a ReceiptLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsReceiptLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsReceiptLookup()} is {@code true} .

getReceiptLookupSessionForMailbox

ReceiptLookupSession getReceiptLookupSessionForMailbox(Id mailboxId)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the receipt lookup service for the given mailbox.

Parameters:

mailboxId - the Id of the mailbox

Returns:

a ReceiptLookupSession

Throws:

NotFoundException - mailboxId not found

NullArgumentException - mailboxId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReceiptLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsReceiptLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getReceiptAdminSession

ReceiptAdminSession getReceiptAdminSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the receipt administrative service.

Returns:

a ReceiptAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsReceiptAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsReceiptAdmin()} is {@code true} .

getReceiptAdminSessionForMailbox

ReceiptAdminSession getReceiptAdminSessionForMailbox(Id mailboxId)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the receipt administrative service for the given mailbox.

Parameters:

mailboxId - the Id of the mailbox

Returns:

a ReceiptAdminSession

Throws:

NotFoundException - mailboxId not found

NullArgumentException - mailboxId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReceiptAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsReceiptAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getReceiptNotificationSession

ReceiptNotificationSession getReceiptNotificationSession(ReceiptReceiver receiptReceiver)
                                                  throws OperationFailedException

Gets the notification session for notifications pertaining to receipt changes.

Parameters:

receiptReceiver - the notification callback

Returns:

a ReceiptNotificationSession

Throws:

NullArgumentException - receiptReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReceiptNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsreceiptNotification()} is {@code true} .

getReceiptNotificationSessionForMailbox

ReceiptNotificationSession getReceiptNotificationSessionForMailbox(ReceiptReceiver receiptReceiver,
 Id mailboxId)
                                                            throws NotFoundException,
OperationFailedException

Gets the receipt notification session for the given mailbox.

Parameters:

receiptReceiver - the notification callback

mailboxId - the Id of the mailbox

Returns:

a ReceiptNotificationSession

Throws:

NotFoundException - mailboxId not found

NullArgumentException - receiptReceiver or mailboxId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReceiptNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsReceiptNotfication()} and {@code supportsVisibleFederation()} are {@code true} .

getMailboxLookupSession

MailboxLookupSession getMailboxLookupSession()
                                      throws OperationFailedException

Gets the mailbox lookup session.

Returns:

a MailboxLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMailboxLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsMailboxLookup()} is {@code true} .

getMailboxQuerySession

MessageQuerySession getMailboxQuerySession()
                                    throws OperationFailedException

Gets the mailbox query session.

Returns:

a MailboxQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMailboxQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsMailboxQuery()} is {@code true} .

getMailboxSearchSession

MailboxSearchSession getMailboxSearchSession()
                                      throws OperationFailedException

Gets the mailbox search session.

Returns:

a MailboxSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMailboxSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsMailboxSearch()} is {@code true} .

getMailboxAdminSession

MailboxAdminSession getMailboxAdminSession()
                                    throws OperationFailedException

Gets the mailbox administrative session for creating, updating and deleteing mailboxes.

Returns:

a MailboxAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMailboxAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsMailboxAdmin()} is {@code true} .

getMailboxNotificationSession

MailboxNotificationSession getMailboxNotificationSession(MailboxReceiver mailboxReceiver)
                                                  throws OperationFailedException

Gets the notification session for subscribing to changes to a mailbox.

Parameters:

mailboxReceiver - the notification callback

Returns:

a MailboxNotificationSession

Throws:

NullArgumentException - mailboxReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMailboxNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsMailboxNotification()} is {@code true} .

getMailboxHierarchySession

MailboxHierarchySession getMailboxHierarchySession()
                                            throws OperationFailedException

Gets the mailbox hierarchy traversal session.

Returns:

a MailboxHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMailboxHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsMailboxHierarchy()} is {@code true} .

getMailboxHierarchyDesignSession

MailboxHierarchyDesignSession getMailboxHierarchyDesignSession()
                                                        throws OperationFailedException

Gets the mailbox hierarchy design session.

Returns:

a MailboxHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMailboxHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsMailboxHierarchyDesign()} is {@code true} .

getMessagingBatchManager

MessagingBatchManager getMessagingBatchManager()
                                        throws OperationFailedException

Gets a MessagingBatchManager .

Returns:

a MessagingBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMessagingBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsMessagingBatch()} is {@code true} .