Interface CookbookBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, CookbookAdminSession, OsidSession, OsidSession
public interface CookbookBatchAdminSession extends CookbookAdminSession

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

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

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

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

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

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