Interface IntersectionBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, IntersectionAdminSession, OsidSession, OsidSession
public interface IntersectionBatchAdminSession extends IntersectionAdminSession

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

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

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

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

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

The delete operations delete Intersections in bulk. To unmap an Intersection from the current Map , the IntersectionMapAssignmentSession should be used. These delete operations attempt to remove the Intersection itself thus removing it from all known Map catalogs. Bulk delete operations return the results in DeleteResponses .