Interface | osid.messaging.batch.MessagingBatchManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.messaging.batch.MessagingBatchProfile | |||
Description |
The messaging batch manager provides access to messaging batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getMessageBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.messaging.batch.MessageBatchAdminSession | a MessageBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsMessageBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsMessageBatchAdmin()
is true. | |
Method | getMessageBatchAdminSessionForMailbox | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mailboxId | the Id of the Mailbox |
Return | osid.messaging.batch.MessageBatchAdminSession | a MessageBatchAdminSession | |
Errors | NOT_FOUND | no Mailbox found by the given Id | |
NULL_ARGUMENT | mailboxId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMessageBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsMessageBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getReceiptBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.messaging.batch.ReceiptBatchAdminSession | a ReceiptBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsReceiptBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsReceiptBatchAdmin()
is true. | |
Method | getReceiptBatchAdminSessionForMailbox | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mailboxId | the Id of the Mailbox |
Return | osid.messaging.batch.ReceiptBatchAdminSession | a ReceiptBatchAdminSession | |
Errors | NOT_FOUND | no Mailbox found by the given Id | |
NULL_ARGUMENT | mailboxId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsReceiptBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsReceiptBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getMailboxBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.messaging.batch.MailboxBatchAdminSession | a MailboxBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsMailboxBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsMailboxBatchAdmin()
is true. |