Interface MessageBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, MessageAdminSession, OsidSession, OsidSession
public interface MessageBatchAdminSession extends MessageAdminSession

This session creates, updates, and deletes Messages 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 Message , a MessageForm is requested using getMessageFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned MessageForms 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 MessageForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each MessageForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Messages in bulk. To unmap a Message from the current Mailbox , the MessageMailboxAssignmentSession should be used. These delete operations attempt to remove the Message itself thus removing it from all known Mailbox catalogs. Bulk delete operations return the results in DeleteResponses .