Interface DictionaryBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, DictionaryAdminSession, OsidSession, OsidSession
public interface DictionaryBatchAdminSession extends DictionaryAdminSession

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

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

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

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

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

The delete operations delete Dictionaries in bulk. Bulk delete operations return the results in DeleteResponses .