Interface ResourceBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ResourceAdminSession
public interface ResourceBatchAdminSession extends ResourceAdminSession

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

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

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

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

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

The delete operations delete Resources in bulk. To unmap a Resource from the current Bin , the ResourceBinAssignmentSession should be used. These delete operations attempt to remove the Resource itself thus removing it from all known Bin catalogs. Bulk delete operations return the results in DeleteResponses .