Interface ResultBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ResultAdminSession
public interface ResultBatchAdminSession extends ResultAdminSession

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

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

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

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

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

The delete operations delete Results in bulk. To unmap a Result from the current Catalogue , the ResultCatalogueAssignmentSession should be used. These delete operations attempt to remove the Result itself thus removing it from all known Catalogue catalogs. Bulk delete operations return the results in DeleteResponses .