Interface QualifierBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, QualifierAdminSession
public interface QualifierBatchAdminSession extends QualifierAdminSession

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

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

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

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

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

The delete operations delete Qualifiers in bulk. To unmap a Qualifier from the current Vault , the QualifierVaultAssignmentSession should be used. These delete operations attempt to remove the Qualifier itself thus removing it from all known Vault catalogs. Bulk delete operations return the results in DeleteResponses .