| Interface | osid.topology.rules.EdgeEnablerGraphAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of an | ||
| Method | canAssignEdgeEnablers | ||
| Description |
Tests if this user can alter edge enabler/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 | canAssignEdgeEnablersToGraph | ||
| Description |
Tests if this user can alter edge enabler/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 ontologies including and under the given graph node in which any edge enabler 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 | getAssignableGraphIdsForEdgeEnabler | ||
| Description |
Gets a list of ontologies including and under the given graph node in which a specific edge enabler can be assigned. | ||
| Parameters | osid.id.Id | graphId | the Id of the Graph |
osid.id.Id | edgeEnablerId | the Id of the EdgeEnabler | |
| Return | osid.id.IdList | list of assignable graph Ids | |
| Errors | NULL_ARGUMENT | graphId or edgeEnablerId is null
| |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignEdgeEnablerToGraph | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | edgeEnablerId | the Id of the EdgeEnabler |
osid.id.Id | graphId | the Id of the Graph | |
| Errors | ALREADY_EXISTS | edgeEnablerId is already assigned to graphId | |
| NOT_FOUND | edgeEnablerId or graphId not found | ||
| NULL_ARGUMENT | edgeEnablerId or graphId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignEdgeEnablerFromGraph | ||
| Description |
Removes an | ||
| Parameters | osid.id.Id | edgeEnablerId | the Id of the EdgeEnabler |
osid.id.Id | graphId | the Id of the Graph | |
| Errors | NOT_FOUND | edgeEnablerId or graphId not found or
edgeEnablerId not assigned to graphId | |
| NULL_ARGUMENT | edgeEnablerId or graphId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignEdgeEnablerToGraph | ||
| Description |
Moves an | ||
| Parameters | osid.id.Id | edgeEnablerId | the Id of the EdgeEnabler |
osid.id.Id | fromGraphId | the Id of the current Graph | |
osid.id.Id | toGraphId | the Id of the destination Graph | |
| Errors | NOT_FOUND | edgeEnablerId, fromGraphId, or toGraphId not
found or edgeEnablerId not mapped to fromGraphId | |
| NULL_ARGUMENT | edgeEnabelrId, fromGraphId, or toGraphId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |