OSID Logo
OSID Specifications
messaging batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.batch.MessagingBatchManager
Implementsosid.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:

  • MessageBatchAdminSession: a session to create, modify and delete messages in bulk
  • ReceiptBatchSession: a session to create, modify and delete receipts in bulk
  • MailboxBatchAdminSession: a session to create, modify and delete mailboxes in bulk
MethodgetMessageBatchAdminSession
Description

Gets the OsidSession associated with the bulk message administration service.

Returnosid.messaging.batch.MessageBatchAdminSessiona MessageBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMessageBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsMessageBatchAdmin() is true.
MethodgetMessageBatchAdminSessionForMailbox
Description

Gets the OsidSession associated with the bulk message administration service for the given mailbox.

Parametersosid.id.IdmailboxIdthe Id of the Mailbox
Returnosid.messaging.batch.MessageBatchAdminSessiona MessageBatchAdminSession
ErrorsNOT_FOUNDno Mailbox found by the given Id
NULL_ARGUMENT mailboxId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMessageBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsMessageBatchAdmin() and supportsVisibleFederation() are true
MethodgetReceiptBatchAdminSession
Description

Gets the OsidSession associated with the bulk receipt administration service.

Returnosid.messaging.batch.ReceiptBatchAdminSessiona ReceiptBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsReceiptBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsReceiptBatchAdmin() is true.
MethodgetReceiptBatchAdminSessionForMailbox
Description

Gets the OsidSession associated with the bulk receipt administration service for the given mailbox.

Parametersosid.id.IdmailboxIdthe Id of the Mailbox
Returnosid.messaging.batch.ReceiptBatchAdminSessiona ReceiptBatchAdminSession
ErrorsNOT_FOUNDno Mailbox found by the given Id
NULL_ARGUMENT mailboxId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsReceiptBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsReceiptBatchAdmin() and supportsVisibleFederation() are true
MethodgetMailboxBatchAdminSession
Description

Gets the OsidSession associated with the bulk mailbox administration service.

Returnosid.messaging.batch.MailboxBatchAdminSessiona MailboxBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMailboxBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsMailboxBatchAdmin() is true.