Interface ModelBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, ModelAdminSession, OsidSession, OsidSession
public interface ModelBatchAdminSession extends ModelAdminSession

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

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

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

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

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

The delete operations delete Models in bulk. To unmap a Model from the current Inventory , the ModelInventoryAssignmentSession should be used. These delete operations attempt to remove the Model itself thus removing it from all known Inventory catalogs. Bulk delete operations return the results in DeleteResponses .