Interface SyllabusBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, SyllabusAdminSession
public interface SyllabusBatchAdminSession extends SyllabusAdminSession

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

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

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

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

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

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