Interface BookBatchAdminSession

All Superinterfaces:
AutoCloseable, BookAdminSession, Closeable, OsidSession, OsidSession
public interface BookBatchAdminSession extends BookAdminSession

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

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

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

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

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

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