Interface RoomBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RoomAdminSession
public interface RoomBatchAdminSession extends RoomAdminSession

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

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

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

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

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

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