Interface MailboxBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, MailboxAdminSession, OsidSession, OsidSession
public interface MailboxBatchAdminSession extends MailboxAdminSession

This session creates, updates, and deletes Mailboxes in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Mailbox , a MailboxForm is requested using getMailboxFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned MailboxForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a MailboxForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each MailboxForm corresponds to an attempted transaction.

The MailboxForms returned from getMailboxFormsForCreate() may be linked to the originating request through the peer Ids of the MailboxForm . In the case where there may be duplicates, any MailboxForm of the same peer Ids may be used for a create operation.

Once a batch of MailboxForms are submitted for create, a CreateResponse is returned for each MailboxForm , although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createMailboxes() , errors specific to an individual MailboxForm are indicated in the corresponding CreateResponse . CreateResponses may be linked to the originating MailboxForm through the MailboxForm Id .

For updates, MailboxForms are requested to the Mailbox Id that is to be updated using getMailboxFormsForUpdate() where the reference Id in the MailboxForm may be used to link the request. Similarly, the MailboxForm has metadata about the data that can be updated and it can perform validation before submitting the update. The MailboxForm can only be used once for a successful update and cannot be reused.

Once a batch of MailboxForms are submitted for update, an UpdateResponse is returned for each MailboxForm , although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateMailboxes() , errors specific to an individual MailboxForm are indicated in the corresponding UpdateResponse . UpdateResponses may be linked to the originating MailboxForm through the MailboxForm Id .

The delete operations delete Mailboxes in bulk. Bulk delete operations return the results in DeleteResponses .