org.osid.topology.batch

Interface NodeBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, NodeAdminSession, 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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasNodes(AliasRequestList aliasRequests) Adds an Id to a Node for the purpose of creating compatibility.
CreateResponseList	createNodes(NodeBatchFormList nodeForms) Creates a new set of Nodes.
DeleteResponseList	deleteAllNodes() Deletes all Nodes in this Graph .
DeleteResponseList	deleteNodes(IdList nodeIds) Deletes nodes for the given Ids.
NodeBatchFormList	getNodeFormsForCreate(long number, Type[] nodeRecordTypes) Gets the node forms for creating a bunch of new nodes.
NodeBatchFormList	getNodeFormsForUpdate(IdList nodeIds) Gets the node forms for updating an existing set of nodes.
UpdateResponseList	updateNodes(NodeBatchFormList nodeForms) Updates existing nodes.

Methods inherited from interface org.osid.topology.NodeAdminSession

aliasNode, canCreateNodes, canCreateNodeWithRecordTypes, canDeleteNodes, canManageNodeAliases, canUpdateNodes, createNode, deleteNode, getGraph, getGraphId, getNodeFormForCreate, getNodeFormForUpdate, updateNode

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNodeFormsForCreate

NodeBatchFormList getNodeFormsForCreate(long number,
                                      Type[] nodeRecordTypes)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

nodeRecordTypes - array of node record types to be included in each create operation or an empty list if none

Returns:

the node forms

Throws:

NullArgumentException - nodeRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createNodes

CreateResponseList createNodes(NodeBatchFormList nodeForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

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 .

Parameters:

nodeForms - the node forms

Returns:

the create responses

Throws:

NullArgumentException - nodeForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getNodeFormsForUpdate

NodeBatchFormList getNodeFormsForUpdate(IdList nodeIds)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

nodeIds - the Ids of the Node

Returns:

the node form

Throws:

NotFoundException - a nodeId is not found

NullArgumentException - nodeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateNodes

UpdateResponseList updateNodes(NodeBatchFormList nodeForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

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 .

Parameters:

nodeForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - nodeForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllNodes

DeleteResponseList deleteAllNodes()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes all Nodes in this Graph .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteNodes

DeleteResponseList deleteNodes(IdList nodeIds)
                               throws OperationFailedException,
                                      PermissionDeniedException

Deletes nodes for the given Ids.

Parameters:

nodeIds - the Ids of the nodes to delete

Returns:

the delete responses

Throws:

NullArgumentException - nodeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasNodes

AliasResponseList aliasNodes(AliasRequestList aliasRequests)
                             throws OperationFailedException,
                                    PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.