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 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.
|
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
MessagingSession getMessagingSession() throws OperationFailedException
OsidSession
associated with the message
sending. a MessagingSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMessaging()
is false
optional
- This method must be implemented if
supportsMessaging()
is true.
MessageLookupSession getMessageLookupSession() throws OperationFailedException
OsidSession
associated with the message lookup
service. a MessageLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMessageLookup()
is false
optional
- This method must be implemented if
supportsMessageLookup()
is true.
MessageLookupSession getMessageLookupSessionForMailbox(Id mailboxId) throws NotFoundException, OperationFailedException
OsidSession
associated with the message lookup
service for the given mailbox.mailboxId
- the Id
of the mailbox a MessageLookupSession
NotFoundException
- mailboxId
not foundNullArgumentException
- mailboxId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsMessageLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMessageLookup()
and
supportsVisibleFederation()
are true.
MessageQuerySession getMessageQuerySession() throws OperationFailedException
OsidSession
associated with the message query
service. MessageQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMessageQuery()
is false
optional
- This method must be implemented if
supportsMessageQuery()
is true.
MessageQuerySession getMessageQuerySessionForMailbox(Id mailboxId) throws NotFoundException, OperationFailedException
OsidSession
associated with the message query
service for the given mailbox.mailboxId
- the Id
of the Mailbox
MessageQuerySession
NotFoundException
- no mailbox found by the given
Id
NullArgumentException
- mailboxId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMessageQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMessageQuery()
and
supportsVisibleFederation()
are true
MessageSearchSession getMessageSearchSession() throws OperationFailedException
a MessageSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMessageSearch()
is false
optional
- This method must be implemented if
supportsMessageSearch()
is true.
MessageSearchSession getMessageSearchSessionForMailbox(Id mailboxId) throws NotFoundException, OperationFailedException
mailboxId
- the Id
of the mailbox a MessageSearchSession
NotFoundException
- mailboxId
not foundNullArgumentException
- mailboxId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsMessageSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMessageSearch()
and
supportsVisibleFederation()
are true.
MessageAdminSession getMessageAdminSession() throws OperationFailedException
a MessageAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMessageAdmin()
is false
optional
- This method must be implemented if
supportsMessageAdmin()
is true.
MessageAdminSession getMessageAdminSessionForMailbox(Id mailboxId) throws NotFoundException, OperationFailedException
mailboxId
- the Id
of the mailbox a MessageAdminSession
NotFoundException
- mailboxId
not foundNullArgumentException
- mailboxId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMessageAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMessageAdmin()
and
supportsVisibleFederation()
are true.
MessageNotificationSession getMessageNotificationSession(MessageReceiver messageReceiver) throws OperationFailedException
messageReceiver
- the notification callback a MessageNotificationSession
NullArgumentException
- messageReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMessageNotification()
is false
optional
- This method must be implemented if
supportsMessageNotification()
is true.
MessageNotificationSession getMessageNotificationSessionForMailbox(MessageReceiver messageReceiver, Id mailboxId) throws NotFoundException, OperationFailedException
messageReceiver
- the notification callbackmailboxId
- the Id
of the mailbox a MessageNotificationSession
NotFoundException
- mailboxId
not foundNullArgumentException
- messageReceiver
or mailboxId
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsMessageNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsMessageNotfication()
and
supportsVisibleFederation()
are true.
MessageMailboxSession getMessageMailboxSession() throws OperationFailedException
MessageMailboxSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMessageMailbox()
is false
optional
- This method must be implemented if
supportsMessageMailbox()
is true.
MessageMailboxAssignmentSession getMessageMailboxAssignmentSession() throws OperationFailedException
MessageMailboxAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMessageMailboxAssignment()
is false
optional
- This method must be implemented if
supportsMessageMailboxAssignment()
is true.
MessageSmartMailboxSession getMessageSmartMailboxSession(Id mailboxId) throws NotFoundException, OperationFailedException
OsidSession
to manage locatin smart mailboxes.mailboxId
- the Id
of the mailbox MessageSmartMailboxSession
NotFoundException
- mailboxId
not foundNullArgumentException
- mailboxId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMessageSmartMailbox()
is false
optional
- This method must be implemented if
supportsMessageSmartMailbox()
is true.
ReceiptLookupSession getReceiptLookupSession() throws OperationFailedException
OsidSession
associated with the receipt lookup
service. a ReceiptLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsReceiptLookup()
is false
optional
- This method must be implemented if
supportsReceiptLookup()
is true.
ReceiptLookupSession getReceiptLookupSessionForMailbox(Id mailboxId) throws NotFoundException, OperationFailedException
OsidSession
associated with the receipt lookup
service for the given mailbox.mailboxId
- the Id
of the mailbox a ReceiptLookupSession
NotFoundException
- mailboxId
not foundNullArgumentException
- mailboxId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsReceiptLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsReceiptLookup()
and
supportsVisibleFederation()
are true.
ReceiptAdminSession getReceiptAdminSession() throws OperationFailedException
OsidSession
associated with the receipt
administrative service. a ReceiptAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsReceiptAdmin()
is false
optional
- This method must be implemented if
supportsReceiptAdmin()
is true.
ReceiptAdminSession getReceiptAdminSessionForMailbox(Id mailboxId) throws NotFoundException, OperationFailedException
OsidSession
associated with the receipt
administrative service for the given mailbox.mailboxId
- the Id
of the mailbox a ReceiptAdminSession
NotFoundException
- mailboxId
not foundNullArgumentException
- mailboxId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsReceiptAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsReceiptAdmin()
and
supportsVisibleFederation()
are true.
ReceiptNotificationSession getReceiptNotificationSession(ReceiptReceiver receiptReceiver) throws OperationFailedException
receiptReceiver
- the notification callback a ReceiptNotificationSession
NullArgumentException
- receiptReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsReceiptNotification()
is false
optional
- This method must be implemented if
supportsreceiptNotification()
is true.
ReceiptNotificationSession getReceiptNotificationSessionForMailbox(ReceiptReceiver receiptReceiver, Id mailboxId) throws NotFoundException, OperationFailedException
receiptReceiver
- the notification callbackmailboxId
- the Id
of the mailbox a ReceiptNotificationSession
NotFoundException
- mailboxId
not foundNullArgumentException
- receiptReceiver
or mailboxId
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsReceiptNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsReceiptNotfication()
and
supportsVisibleFederation()
are true.
MailboxLookupSession getMailboxLookupSession() throws OperationFailedException
MailboxLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMailboxLookup()
is false
optional
- This method must be implemented if
supportsMailboxLookup()
is true.
MessageQuerySession getMailboxQuerySession() throws OperationFailedException
MailboxQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMailboxQuery()
is false
optional
- This method must be implemented if
supportsMailboxQuery()
is true.
MailboxSearchSession getMailboxSearchSession() throws OperationFailedException
MailboxSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMailboxSearch()
is false
optional
- This method must be implemented if
supportsMailboxSearch()
is true.
MailboxAdminSession getMailboxAdminSession() throws OperationFailedException
MailboxAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMailboxAdmin()
is false
optional
- This method must be implemented if
supportsMailboxAdmin()
is true.
MailboxNotificationSession getMailboxNotificationSession(MailboxReceiver mailboxReceiver) throws OperationFailedException
mailboxReceiver
- the notification callback MailboxNotificationSession
NullArgumentException
- mailboxReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMailboxNotification()
is false
optional
- This method must be implemented if
supportsMailboxNotification()
is true.
MailboxHierarchySession getMailboxHierarchySession() throws OperationFailedException
a MailboxHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMailboxHierarchy()
is false
optional
- This method must be implemented if
supportsMailboxHierarchy()
is true.
MailboxHierarchyDesignSession getMailboxHierarchyDesignSession() throws OperationFailedException
MailboxHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMailboxHierarchyDesign()
is false
optional
- This method must be implemented if
supportsMailboxHierarchyDesign()
is true.
MessagingBatchManager getMessagingBatchManager() throws OperationFailedException
MessagingBatchManager.
MessagingBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMessagingBatch()
is false
optional
- This method must be implemented if
supportsMessagingBatch()
is true.