Interface TextBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, TextAdminSession
public interface TextBatchAdminSession extends TextAdminSession

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

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

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

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

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

The delete operations delete Texts in bulk. To unmap a Text from the current Press , the TextPressAssignmentSession should be used. These delete operations attempt to remove the Text itself thus removing it from all known Press catalogs. Bulk delete operations return the results in DeleteResponses .