Interface ProgramEntryBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProgramEntryAdminSession
public interface ProgramEntryBatchAdminSession extends ProgramEntryAdminSession

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

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

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

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

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

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