Interface DeviceBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, DeviceAdminSession, OsidSession, OsidSession
public interface DeviceBatchAdminSession extends DeviceAdminSession

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

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

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

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

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

The delete operations delete Devices in bulk. To unmap a Device from the current System , the DeviceSystemAssignmentSession should be used. These delete operations attempt to remove the Device itself thus removing it from all known System catalogs. Bulk delete operations return the results in DeleteDevices .