Interface | osid.topology.batch.NodeBatchAdminSession | ||
---|---|---|---|
Implements | osid.topology.NodeAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getNodeFormsForCreate | ||
Description |
Gets the node forms for creating a bunch of new nodes. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | nodeRecordTypes | array of node record types to be included in each create operation or an empty list if none | |
Return | osid.topology.batch.NodeBatchFormList | the node forms | |
Errors | NULL_ARGUMENT | nodeRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createNodes | ||
Description |
Creates a new set of | ||
Parameters | osid.topology.batch.NodeBatchFormList | nodeForms | the node forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | nodeForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getNodeFormsForUpdate | ||
Description |
Gets the node forms for updating an existing set of nodes. A new node form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | nodeIds | the Ids of the Node |
Return | osid.topology.batch.NodeBatchFormList | the node form | |
Errors | NOT_FOUND | a nodeId is not found | |
NULL_ARGUMENT | nodeIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateNodes | ||
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 | ||
Parameters | osid.topology.batch.NodeBatchFormList | nodeForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | nodeForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllNodes | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteNodes | ||
Description |
Deletes nodes for the given | ||
Parameters | osid.id.IdList | nodeIds | the Ids of the nodes to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | nodeIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasNodes | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |