Interface BuildingBatchAdminSession

All Superinterfaces:
AutoCloseable, BuildingAdminSession, Closeable, OsidSession, OsidSession
public interface BuildingBatchAdminSession extends BuildingAdminSession

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

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

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

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

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

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