org.osid.messaging

Interface MessagingManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, MessagingProfile, 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

Methods

Modifier and Type	Method and 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 org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.messaging.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

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

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 supportsMessaging() is 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 supportsMessageLookup() is 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 supportsMessageLookup() and supportsVisibleFederation() are 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 supportsMessageQuery() is 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 supportsMessageQuery() and supportsVisibleFederation() are 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 supportsMessageSearch() is 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 supportsMessageSearch() and supportsVisibleFederation() are 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 supportsMessageAdmin() is 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 supportsMessageAdmin() and supportsVisibleFederation() are 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 supportsMessageNotification() is 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 supportsMessageNotfication() and supportsVisibleFederation() are 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 supportsMessageMailbox() is 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 supportsMessageMailboxAssignment() is 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 supportsMessageSmartMailbox() is 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 supportsReceiptLookup() is 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 supportsReceiptLookup() and supportsVisibleFederation() are 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 supportsReceiptAdmin() is 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 supportsReceiptAdmin() and supportsVisibleFederation() are 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 supportsreceiptNotification() is 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 supportsReceiptNotfication() and supportsVisibleFederation() are 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 supportsMailboxLookup() is 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 supportsMailboxQuery() is 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 supportsMailboxSearch() is 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 supportsMailboxAdmin() is 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 supportsMailboxNotification() is 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 supportsMailboxHierarchy() is 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 supportsMailboxHierarchyDesign() is 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 supportsMessagingBatch() is true.