Interface ProgramBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProgramAdminSession
public interface ProgramBatchAdminSession extends ProgramAdminSession

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

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

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

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

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

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