OSID Logo
OSID Specifications
topology batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.batch.NodeBatchAdminSession
Implementsosid.topology.NodeAdminSession
Description

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.

MethodgetNodeFormsForCreate
Description

Gets the node forms for creating a bunch of new nodes.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]nodeRecordTypesarray of node record types to be included in each create operation or an empty list if none
Returnosid.topology.batch.NodeBatchFormListthe node forms
ErrorsNULL_ARGUMENT nodeRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateNodes
Description

Creates a new set of Nodes. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.topology.batch.NodeBatchFormListnodeFormsthe node forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT nodeForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetNodeFormsForUpdate
Description

Gets the node forms for updating an existing set of nodes. A new node form should be requested for each update transaction.

Parametersosid.id.IdListnodeIdsthe Ids of the Node
Returnosid.topology.batch.NodeBatchFormListthe node form
ErrorsNOT_FOUNDa nodeId is not found
NULL_ARGUMENT nodeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateNodes
Description

Updates existing nodes. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.topology.batch.NodeBatchFormListnodeFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT nodeForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllNodes
Description

Deletes all Nodes in this Graph .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteNodes
Description

Deletes nodes for the given Ids.

Parametersosid.id.IdListnodeIdsthe Ids of the nodes to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT nodeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasNodes
Description

Adds an Id to a Node for the purpose of creating compatibility. The primary Id of the Node is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another node, it is reassigned to the given node Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.