| Interface | osid.topology.EdgeGraphAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of an | ||
| Method | canAssignEdges | ||
| Description |
Tests if this user can alter edge/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 | canAssignEdgesToGraph | ||
| Description |
Tests if this user can alter edge/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 edge 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 | getAssignableGraphIdsForEdge | ||
| Description |
Gets a list of graphs including and under the given graph node in which a specific edge can be assigned. | ||
| Parameters | osid.id.Id | graphId | the Id of the Graph |
osid.id.Id | edgeId | the Id of the Edge | |
| Return | osid.id.IdList | list of assignable graph Ids | |
| Errors | NULL_ARGUMENT | graphId or edgeId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignEdgeToGraph | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | edgeId | the Id of the Edge |
osid.id.Id | graphId | the Id of the Graph | |
| Errors | ALREADY_EXISTS | edgeId is already assigned to graphId | |
| NOT_FOUND | edgeId or graphId not found | ||
| NULL_ARGUMENT | edgeId or graphId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignEdgeFromGraph | ||
| Description |
Removes an | ||
| Parameters | osid.id.Id | edgeId | the Id of the Edge |
osid.id.Id | graphId | the Id of the Graph | |
| Errors | NOT_FOUND | edgeId or graphId not found or edgeId
not assigned to graphId | |
| NULL_ARGUMENT | edgeId or graphId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignEdgeToGraph | ||
| Description |
Moves an | ||
| Parameters | osid.id.Id | edgeId | the Id of the Edge |
osid.id.Id | fromGraphId | the Id of the current Graph | |
osid.id.Id | toGraphId | the Id of the destination Graph | |
| Errors | NOT_FOUND | edgeId, fromGraphId, or toGraphId not found
or edgeId not mapped to fromGraphId | |
| NULL_ARGUMENT | edgeId, fromGraphId, or toGraphId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |