Interface CourseCatalogBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, CourseCatalogAdminSession, OsidSession, OsidSession
public interface CourseCatalogBatchAdminSession extends CourseCatalogAdminSession

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

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

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

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

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

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