Interface BlockBatchAdminSession

All Superinterfaces:
AutoCloseable, BlockAdminSession, Closeable, OsidSession, OsidSession
public interface BlockBatchAdminSession extends BlockAdminSession

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

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

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

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

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

The delete operations delete Blocks in bulk. To unmap a Block from the current Oubliette , the BlockOublietteAssignmentSession should be used. These delete operations attempt to remove the Block itself thus removing it from all known Oubliette catalogs. Bulk delete operations return the results in DeleteResponses .