Interface MessagingBatchProxyManager
- All Superinterfaces:
AutoCloseable, Closeable, MessagingBatchProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable
The messaging batch proxy manager provides access to messaging batch
sessions and provides interoperability tests for various aspects of this
service. Methods in this manager support the passing of a Proxy
object. 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 TypeMethodDescriptiongetMailboxBatchAdminSession(Proxy proxy) Gets theOsidSessionassociated with the bulk mailbox administration service.getMessageBatchAdminSession(Proxy proxy) Gets theOsidSessionassociated with the bulk message administration service.getMessageBatchAdminSessionForMailbox(Id mailboxId, Proxy proxy) Gets theOsidSessionassociated with the bulk message administration service for the given mailbox.getReceiptBatchAdminSession(Proxy proxy) Gets theOsidSessionassociated with the bulk receipt administration service.getReceiptBatchAdminSessionForMailbox(Id mailboxId, Proxy proxy) Gets theOsidSessionassociated with the bulk receipt administration service for the given mailbox.Methods inherited from interface MessagingBatchProfile
supportsMailboxBatchAdmin, supportsMessageBatchAdmin, supportsReceiptBatchAdmin, supportsVisibleFederationModifier and TypeMethodDescriptionbooleanTests if bulk administration of mailboxes is available.booleanTests if bulk administration of messages is available.booleanTests if bulk administration of receipts is available.booleanTests if federation is visible.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface OsidProxyManager
closeMethods inherited from interface OsidProxyManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId, Proxy proxy) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime, Proxy proxy) Rolls back this service to a point in time.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
getMessageBatchAdminSession
Gets theOsidSessionassociated with the bulk message administration service.- Parameters:
proxy- a proxy- Returns:
- a
MessageBatchAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsMessageBatchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsMessageBatchAdmin()} is {@code true} .
-
getMessageBatchAdminSessionForMailbox
MessageBatchAdminSession getMessageBatchAdminSessionForMailbox(Id mailboxId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the bulk message administration service for the given mailbox.- Parameters:
mailboxId- theIdof theMailboxproxy- a proxy- Returns:
- a
MessageBatchAdminSession - Throws:
NotFoundException- noMailboxfound by the givenIdNullArgumentException-mailboxIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsMessageBatchAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsMessageBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getReceiptBatchAdminSession
Gets theOsidSessionassociated with the bulk receipt administration service.- Parameters:
proxy- a proxy- Returns:
- a
ReceiptBatchAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsReceiptBatchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsReceiptBatchAdmin()} is {@code true} .
-
getReceiptBatchAdminSessionForMailbox
ReceiptBatchAdminSession getReceiptBatchAdminSessionForMailbox(Id mailboxId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the bulk receipt administration service for the given mailbox.- Parameters:
mailboxId- theIdof theMailboxproxy- a proxy- Returns:
- a
ReceiptBatchAdminSession - Throws:
NotFoundException- noMailboxfound by the givenIdNullArgumentException-mailboxIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsReceiptBatchAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsReceiptBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getMailboxBatchAdminSession
Gets theOsidSessionassociated with the bulk mailbox administration service.- Parameters:
proxy- a proxy- Returns:
- a
MailboxBatchAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsMailboxBatchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsMailboxBatchAdmin()} is {@code true} .
-