OSID - osid.messaging.MessagingManager Service Interface Definition

Interface	osid.messaging.MessagingManager
Implements	`osid.OsidManager`
Implements	`osid.messaging.MessagingProfile`
Description	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	getMessagingSession
Description	Gets the `OsidSession` associated with the message sending.
Return	`osid.messaging.MessagingSession`		`a MessagingSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMessaging()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMessaging()` is `true.`
Method	getMessageLookupSession
Description	Gets the `OsidSession` associated with the message lookup service.
Return	`osid.messaging.MessageLookupSession`		`a MessageLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMessageLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMessageLookup()` is `true.`
Method	getMessageLookupSessionForMailbox
Description	Gets the `OsidSession` associated with the message lookup service for the given mailbox.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the mailbox
Return	`osid.messaging.MessageLookupSession`		`a MessageLookupSession`
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsMessageLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMessageLookup()` and `supportsVisibleFederation()` are `true.`
Method	getMessageQuerySession
Description	Gets the `OsidSession` associated with the message query service.
Return	`osid.messaging.MessageQuerySession`		a `MessageQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMessageQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMessageQuery()` is `true.`
Method	getMessageQuerySessionForMailbox
Description	Gets the `OsidSession` associated with the message query service for the given mailbox.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the `Mailbox`
Return	`osid.messaging.MessageQuerySession`		a `MessageQuerySession`
Errors	NOT_FOUND		no mailbox found by the given `Id`
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsMessageQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMessageQuery()` and `supportsVisibleFederation()` are `true`
Method	getMessageSearchSession
Description	Gets a message search session.
Return	`osid.messaging.MessageSearchSession`		`a MessageSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMessageSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMessageSearch()` is `true.`
Method	getMessageSearchSessionForMailbox
Description	Gets a message search session for the given mailbox.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the mailbox
Return	`osid.messaging.MessageSearchSession`		`a MessageSearchSession`
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsMessageSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMessageSearch()` and `supportsVisibleFederation()` are `true.`
Method	getMessageAdminSession
Description	Gets a message administration session for creating, updating and deleting messages.
Return	`osid.messaging.MessageAdminSession`		`a MessageAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMessageAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMessageAdmin()` is `true.`
Method	getMessageAdminSessionForMailbox
Description	Gets a message administration session for the given mailbox.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the mailbox
Return	`osid.messaging.MessageAdminSession`		`a MessageAdminSession`
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsMessageAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMessageAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getMessageNotificationSession
Description	Gets the notification session for notifications pertaining to message changes.
Parameters	`osid.messaging.MessageReceiver`	`messageReceiver`	the notification callback
Return	`osid.messaging.MessageNotificationSession`		`a MessageNotificationSession`
Errors	NULL_ARGUMENT		`messageReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsMessageNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMessageNotification()` is `true.`
Method	getMessageNotificationSessionForMailbox
Description	Gets the message notification session for the given mailbox.
Parameters	`osid.messaging.MessageReceiver`	`messageReceiver`	the notification callback
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the mailbox
Return	`osid.messaging.MessageNotificationSession`		`a MessageNotificationSession`
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`messageReceiver` or `mailboxId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsMessageNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMessageNotfication()` and `supportsVisibleFederation()` are `true.`
Method	getMessageMailboxSession
Description	Gets the session for retrieving message to mailbox mappings.
Return	`osid.messaging.MessageMailboxSession`		a `MessageMailboxSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMessageMailbox()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMessageMailbox()` is `true.`
Method	getMessageMailboxAssignmentSession
Description	Gets the session for assigning message to mailbox mappings.
Return	`osid.messaging.MessageMailboxAssignmentSession`		a `MessageMailboxAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMessageMailboxAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMessageMailboxAssignment()` is `true.`
Method	getMessageSmartMailboxSession
Description	Gets the `OsidSession` to manage locatin smart mailboxes.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the mailbox
Return	`osid.messaging.MessageSmartMailboxSession`		a `MessageSmartMailboxSession`
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsMessageSmartMailbox()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMessageSmartMailbox()` is `true.`
Method	getReceiptLookupSession
Description	Gets the `OsidSession` associated with the receipt lookup service.
Return	`osid.messaging.ReceiptLookupSession`		`a ReceiptLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsReceiptLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsReceiptLookup()` is `true.`
Method	getReceiptLookupSessionForMailbox
Description	Gets the `OsidSession` associated with the receipt lookup service for the given mailbox.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the mailbox
Return	`osid.messaging.ReceiptLookupSession`		`a ReceiptLookupSession`
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsReceiptLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsReceiptLookup()` and `supportsVisibleFederation()` are `true.`
Method	getReceiptAdminSession
Description	Gets the `OsidSession` associated with the receipt administrative service.
Return	`osid.messaging.ReceiptAdminSession`		`a ReceiptAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsReceiptAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsReceiptAdmin()` is `true.`
Method	getReceiptAdminSessionForMailbox
Description	Gets the `OsidSession` associated with the receipt administrative service for the given mailbox.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the mailbox
Return	`osid.messaging.ReceiptAdminSession`		`a ReceiptAdminSession`
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsReceiptAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsReceiptAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getReceiptNotificationSession
Description	Gets the notification session for notifications pertaining to receipt changes.
Parameters	`osid.messaging.ReceiptReceiver`	`receiptReceiver`	the notification callback
Return	`osid.messaging.ReceiptNotificationSession`		`a ReceiptNotificationSession`
Errors	NULL_ARGUMENT		`receiptReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsReceiptNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsreceiptNotification()` is `true.`
Method	getReceiptNotificationSessionForMailbox
Description	Gets the receipt notification session for the given mailbox.
Parameters	`osid.messaging.ReceiptReceiver`	`receiptReceiver`	the notification callback
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the mailbox
Return	`osid.messaging.ReceiptNotificationSession`		`a ReceiptNotificationSession`
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`receiptReceiver` or `mailboxId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsReceiptNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsReceiptNotfication()` and `supportsVisibleFederation()` are `true.`
Method	getMailboxLookupSession
Description	Gets the mailbox lookup session.
Return	`osid.messaging.MailboxLookupSession`		a `MailboxLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMailboxLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMailboxLookup()` is `true.`
Method	getMailboxQuerySession
Description	Gets the mailbox query session.
Return	`osid.messaging.MessageQuerySession`		a `MailboxQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMailboxQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMailboxQuery()` is `true.`
Method	getMailboxSearchSession
Description	Gets the mailbox search session.
Return	`osid.messaging.MailboxSearchSession`		a `MailboxSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMailboxSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMailboxSearch()` is `true.`
Method	getMailboxAdminSession
Description	Gets the mailbox administrative session for creating, updating and deleteing mailboxes.
Return	`osid.messaging.MailboxAdminSession`		a `MailboxAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMailboxAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMailboxAdmin()` is `true.`
Method	getMailboxNotificationSession
Description	Gets the notification session for subscribing to changes to a mailbox.
Parameters	`osid.messaging.MailboxReceiver`	`mailboxReceiver`	the notification callback
Return	`osid.messaging.MailboxNotificationSession`		a `MailboxNotificationSession`
Errors	NULL_ARGUMENT		`mailboxReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsMailboxNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMailboxNotification()` is `true.`
Method	getMailboxHierarchySession
Description	Gets the mailbox hierarchy traversal session.
Return	`osid.messaging.MailboxHierarchySession`		`a MailboxHierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMailboxHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMailboxHierarchy()` is `true.`
Method	getMailboxHierarchyDesignSession
Description	Gets the mailbox hierarchy design session.
Return	`osid.messaging.MailboxHierarchyDesignSession`		a `MailboxHierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMailboxHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMailboxHierarchyDesign()` is `true.`
Method	getMessagingBatchManager
Description	Gets a `MessagingBatchManager.`
Return	`osid.messaging.batch.MessagingBatchManager`		a `MessagingBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMessagingBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMessagingBatch()` is `true.`