Interface GraphBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, GraphAdminSession, OsidSession, OsidSession
public interface GraphBatchAdminSession extends GraphAdminSession

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

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

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

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

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

The delete operations delete Graphs in bulk. Bulk delete operations return the results in DeleteResponses .