Interface DeedBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, DeedAdminSession, OsidSession, OsidSession
public interface DeedBatchAdminSession extends DeedAdminSession

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

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

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

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

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

The delete operations delete Deeds in bulk. To unmap a Deed from the current Campus , the DeedCampusAssignmentSession should be used. These delete operations attempt to remove the Deed itself thus removing it from all known Campus catalogs. Bulk delete operations return the results in DeleteResponses .