org.osid.messaging.batch

Interface MessagingBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, MessagingBatchProfile, OsidManager, OsidProfile, Sourceable

public interface MessagingBatchManager
extends OsidManager, MessagingBatchProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
MailboxBatchAdminSession	getMailboxBatchAdminSession() Gets the OsidSession associated with the bulk mailbox administration service.
MessageBatchAdminSession	getMessageBatchAdminSession() Gets the OsidSession associated with the bulk message administration service.
MessageBatchAdminSession	getMessageBatchAdminSessionForMailbox(Id mailboxId) Gets the OsidSession associated with the bulk message administration service for the given mailbox.
ReceiptBatchAdminSession	getReceiptBatchAdminSession() Gets the OsidSession associated with the bulk receipt administration service.
ReceiptBatchAdminSession	getReceiptBatchAdminSessionForMailbox(Id mailboxId) Gets the OsidSession associated with the bulk receipt administration service 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.batch.MessagingBatchProfile

supportsMailboxBatchAdmin, supportsMessageBatchAdmin, supportsReceiptBatchAdmin, 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

getMessageBatchAdminSession

MessageBatchAdminSession getMessageBatchAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk message administration service.

Returns:

a MessageBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsMessageBatchAdmin() is true.

getMessageBatchAdminSessionForMailbox

MessageBatchAdminSession getMessageBatchAdminSessionForMailbox(Id mailboxId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

mailboxId - the Id of the Mailbox

Returns:

a MessageBatchAdminSession

Throws:

NotFoundException - no Mailbox found by the given Id

NullArgumentException - mailboxId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMessageBatchAdmin() and supportsVisibleFederation() are true

getReceiptBatchAdminSession

ReceiptBatchAdminSession getReceiptBatchAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk receipt administration service.

Returns:

a ReceiptBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsReceiptBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsReceiptBatchAdmin() is true.

getReceiptBatchAdminSessionForMailbox

ReceiptBatchAdminSession getReceiptBatchAdminSessionForMailbox(Id mailboxId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

mailboxId - the Id of the Mailbox

Returns:

a ReceiptBatchAdminSession

Throws:

NotFoundException - no Mailbox found by the given Id

NullArgumentException - mailboxId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReceiptBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsReceiptBatchAdmin() and supportsVisibleFederation() are true

getMailboxBatchAdminSession

MailboxBatchAdminSession getMailboxBatchAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk mailbox administration service.

Returns:

a MailboxBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMailboxBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsMailboxBatchAdmin() is true.