Interface ControllerBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, ControllerAdminSession, OsidSession, OsidSession
public interface ControllerBatchAdminSession extends ControllerAdminSession

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

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

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

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

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

The delete operations delete Controllers in bulk. To unmap a Controller from the current System , the ControllerSystemAssignmentSession should be used. These delete operations attempt to remove the Controller itself thus removing it from all known System catalogs. Bulk delete operations return the results in DeleteControllers .