Interface AssetBatchAdminSession

All Superinterfaces:
AssetAdminSession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AssetBatchAdminSession extends AssetAdminSession

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

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

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

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

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

The delete operations delete Assets in bulk. To unmap an Asset from the current Repository , the AssetRepositoryAssignmentSession should be used. These delete operations attempt to remove the Asset itself thus removing it from all known Repository catalogs. Bulk delete operations return the results in DeleteResponses .