Interface ResourceRelationshipBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ResourceRelationshipAdminSession
public interface ResourceRelationshipBatchAdminSession extends ResourceRelationshipAdminSession

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

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

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

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

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

The delete operations delete ResourceRelationships in bulk. To unmap a ResourceRelationship from the current Bin , the ResourceRelationshipBinAssignmentSession should be used. These delete operations attempt to remove the ResourceRelationship itself thus removing it from all known Bin catalogs. Bulk delete operations return the results in DeleteResponses .