Interface ActivityBatchAdminSession

All Superinterfaces:
ActivityAdminSession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface ActivityBatchAdminSession extends ActivityAdminSession

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

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

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

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

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

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