Interface RepositoryBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RepositoryAdminSession
public interface RepositoryBatchAdminSession extends RepositoryAdminSession

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

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

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

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

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

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