Interface CatalogueBatchAdminSession

All Superinterfaces:
AutoCloseable, CatalogueAdminSession, Closeable, OsidSession, OsidSession
public interface CatalogueBatchAdminSession extends CatalogueAdminSession

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

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

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

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

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

The delete operations delete Catalogues in bulk. To unmap a Catalogue from the current Calendar , the CatalogueCalendarAssignmentSession should be used. These delete operations attempt to remove the Catalogue itself thus removing it from all known Calendar catalogs. Bulk delete operations return the results in DeleteResponses .