Interface ValueBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ValueAdminSession
public interface ValueBatchAdminSession extends ValueAdminSession

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

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

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

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

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

The delete operations delete Values in bulk. To unmap a Value from the current Configuration , the ValueConfigurationAssignmentSession should be used. These delete operations attempt to remove the Value itself thus removing it from all known Configuration catalogs. Bulk delete operations return the results in DeleteResponses .