Interface VaultBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, VaultAdminSession
public interface VaultBatchAdminSession extends VaultAdminSession

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

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

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

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

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

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