Interface CampusBatchAdminSession

All Superinterfaces:
AutoCloseable, CampusAdminSession, Closeable, OsidSession, OsidSession
public interface CampusBatchAdminSession extends CampusAdminSession

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

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

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

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

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

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