Interface MessagingBatchManager

All Superinterfaces:

AutoCloseable, Closeable, MessagingBatchProfile, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface MessagingBatchProfile

supportsMailboxBatchAdmin, supportsMessageBatchAdmin, supportsReceiptBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsMailboxBatchAdmin()	Tests if bulk administration of mailboxes is available.
boolean	supportsMessageBatchAdmin()	Tests if bulk administration of messages is available.
boolean	supportsReceiptBatchAdmin()	Tests if bulk administration of receipts is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsMessageBatchAdmin()} is {@code 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 {@code supportsMessageBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsReceiptBatchAdmin()} is {@code 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 {@code supportsReceiptBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsMailboxBatchAdmin()} is {@code true} .