Interface ProficiencyBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProficiencyAdminSession
public interface ProficiencyBatchAdminSession extends ProficiencyAdminSession

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

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

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

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

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

The delete operations delete Proficiencies in bulk. To unmap a Proficiency from the current ObjectiveBank , the ProficiencyObjectiveBankAssignmentSession should be used. These delete operations attempt to remove the Proficiency itself thus removing it from all known ObjectiveBank catalogs. Bulk delete operations return the results in DeleteResponses .