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 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. |
changeBranch, initialize, rollbackService
close
supportsMailboxBatchAdmin, supportsMessageBatchAdmin, supportsReceiptBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
MessageBatchAdminSession getMessageBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk message
administration service. MessageBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMessageBatchAdmin()
is false
optional
- This method must be implemented if
supportsMessageBatchAdmin()
is true.
MessageBatchAdminSession getMessageBatchAdminSessionForMailbox(Id mailboxId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk message
administration service for the given mailbox.mailboxId
- the Id
of the Mailbox
MessageBatchAdminSession
NotFoundException
- no Mailbox
found by
the given Id
NullArgumentException
- mailboxId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMessageBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsMessageBatchAdmin()
and
supportsVisibleFederation()
are true
ReceiptBatchAdminSession getReceiptBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk receipt
administration service. ReceiptBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsReceiptBatchAdmin()
is false
optional
- This method must be implemented if
supportsReceiptBatchAdmin()
is true.
ReceiptBatchAdminSession getReceiptBatchAdminSessionForMailbox(Id mailboxId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk receipt
administration service for the given mailbox.mailboxId
- the Id
of the Mailbox
ReceiptBatchAdminSession
NotFoundException
- no Mailbox
found by
the given Id
NullArgumentException
- mailboxId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsReceiptBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsReceiptBatchAdmin()
and
supportsVisibleFederation()
are true
MailboxBatchAdminSession getMailboxBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk mailbox
administration service. MailboxBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMailboxBatchAdmin()
is false
optional
- This method must be implemented if
supportsMailboxBatchAdmin()
is true.