Interface | osid.topology.NodeGraphAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignNodes | ||
Description |
Tests if this user can alter node/graph mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignNodesToGraph | ||
Description |
Tests if this user can alter node/graph mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Parameters | osid.id.Id | graphId | the Id of the Graph |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | graphId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableGraphIds | ||
Description |
Gets a list of graphs including and under the given graph node in which any node can be assigned. | ||
Parameters | osid.id.Id | graphId | the Id of the Graph |
Return | osid.id.IdList | list of assignable graph Ids | |
Errors | NULL_ARGUMENT | graphId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableGraphIdsForNode | ||
Description |
Gets a list of graphs including and under the given graph node in which a specific node can be assigned. | ||
Parameters | osid.id.Id | graphId | the Id of the Graph |
osid.id.Id | nodeId | the Id of the Node | |
Return | osid.id.IdList | list of assignable graph Ids | |
Errors | NULL_ARGUMENT | graphId or nodeId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignNodeToGraph | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | nodeId | the Id of the Node |
osid.id.Id | graphId | the Id of the Graph | |
Errors | ALREADY_EXISTS | nodeId is already assigned to graphId | |
NOT_FOUND | nodeId or graphId not found | ||
NULL_ARGUMENT | nodeId or graphId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignNodeFromGraph | ||
Description |
Removes a | ||
Parameters | osid.id.Id | nodeId | the Id of the Node |
osid.id.Id | graphId | the Id of the Graph | |
Errors | NOT_FOUND | nodeId or graphId not found or nodeId
not assigned to graphId | |
NULL_ARGUMENT | nodeId or graphId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignNodeToGraph | ||
Description |
Moves a | ||
Parameters | osid.id.Id | nodeId | the Id of the Node |
osid.id.Id | fromGraphId | the Id of the current Graph | |
osid.id.Id | toGraphId | the Id of the destination Graph | |
Errors | NOT_FOUND | nodeId, fromGraphId, or toGraphId not found
or nodeId not mapped to fromGraphId | |
NULL_ARGUMENT | nodeId, fromGraphId, or toGraphId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |