Interface SubjectBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, SubjectAdminSession
public interface SubjectBatchAdminSession extends SubjectAdminSession

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

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

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

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

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

The delete operations delete Subjects in bulk. To unmap a Subject from the current Ontology , the SubjectOntologyAssignmentSession should be used. These delete operations attempt to remove the Subject itself thus removing it from all known Ontology catalogs. Bulk delete operations return the results in DeleteResponses .