Interface WorkBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, WorkAdminSession
public interface WorkBatchAdminSession extends WorkAdminSession

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

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

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

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

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

The delete operations delete Works in bulk. To unmap a Work from the current Foundry , the WorkFoundryAssignmentSession should be used. These delete operations attempt to remove the Work itself thus removing it from all known Foundry catalogs. Bulk delete operations return the results in DeleteResponses .