Interface NodeBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, NodeAdminSession, OsidSession, OsidSession
public interface NodeBatchAdminSession extends NodeAdminSession

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

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

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

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

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

The delete operations delete Nodes in bulk. To unmap a Node from the current Graph , the NodeGraphAssignmentSession should be used. These delete operations attempt to remove the Node itself thus removing it from all known Graph catalogs. Bulk delete operations return the results in DeleteResponses .