Interface EdgeBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, EdgeAdminSession, OsidSession, OsidSession
public interface EdgeBatchAdminSession extends EdgeAdminSession

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

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

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

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

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

The delete operations delete Edges in bulk. To unmap an Edge from the current Graph , the EdgeGraphAssignmentSession should be used. These delete operations attempt to remove the Edge itself thus removing it from all known Graph catalogs. Bulk delete operations return the results in DeleteResponses .