Interface ActivityUnitBatchAdminSession

All Superinterfaces:
ActivityUnitAdminSession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface ActivityUnitBatchAdminSession extends ActivityUnitAdminSession

This session creates, updates, and deletes ActivityUnits 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 an ActivityUnit, an ActivityUnitForm is requested using getActivityUnitFormsForCreate() specifying the desired course and record Types or none if no record Types are needed. Each of the returned ActivityUnitForms will indicate that it is to be used with a create operation and can be used to examine metadata or validate data prior to creation. Once an ActivityUnitForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ActivityUnitForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete ActivityUnits in bulk. To unmap an ActivityUnit from the current CourseCatalog, the ActivityUnitCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the ActivityUnit itself thus removing it from all known CourseCatalog catalogs. Bulk delete operations return the results in DeleteResponses.

Like all OsidSessions, ActivityUnitBatchAdminSessions are dedicated to single processing threads and a single authenticated user.