Interface FloorBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, FloorAdminSession, OsidSession, OsidSession
public interface FloorBatchAdminSession extends FloorAdminSession

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

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

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

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

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

The delete operations delete Floors in bulk. To unmap a Floor from the current Campus , the FloorCampusAssignmentSession should be used. These delete operations attempt to remove the Floor itself thus removing it from all known Campus catalogs. Bulk delete operations return the results in DeleteResponses .