Interface SystemBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, SystemAdminSession
public interface SystemBatchAdminSession extends SystemAdminSession

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

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

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

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

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

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