Interface InputBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, InputAdminSession, OsidSession, OsidSession
public interface InputBatchAdminSession extends InputAdminSession

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

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

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

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

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

The delete operations delete Inputs in bulk. To unmap an Input from the current System , the InputSystemAssignmentSession should be used. These delete operations attempt to remove the Input itself thus removing it from all known System catalogs. Bulk delete operations return the results in DeleteInputs .