Interface RelationshipBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RelationshipAdminSession
public interface RelationshipBatchAdminSession extends RelationshipAdminSession

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

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

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

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

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

The delete operations delete Relationships in bulk. To unmap a Relationship from the current Family , the RelationshipFamilyAssignmentSession should be used. These delete operations attempt to remove the Relationship itself thus removing it from all known Family catalogs. Bulk delete operations return the results in DeleteResponses .