Interface TermBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, TermAdminSession
public interface TermBatchAdminSession extends TermAdminSession

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

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

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

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

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

The delete operations delete Terms in bulk. To unmap a Term from the current CourseCatalog , the TermCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the Term itself thus removing it from all known CourseCatalog catalogs. Bulk delete operations return the results in DeleteResponses .