OSID Specifications
topology package
Version 3.0.0
topology package
Version 3.0.0
| Interface | osid.topology.GraphHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.topology.TopologyManager | ||
osid.topology.TopologyProxyManager | |||
| Description |
This session defines methods for managing a hierarchy of
| ||
| Method | getGraphHierarchyId | ||
| Description |
Gets the hierarchy | ||
| Return | osid.id.Id | the hierarchy Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGraphHierarchy | ||
| Description |
Gets the hierarchy associated with this session. | ||
| Return | osid.hierarchy.Hierarchy | the hierarchy associated with this session | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canModifyGraphHierarchy | ||
| Description |
Tests if this user can change the hierarchy. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known performing any
update will result in a | ||
| Return | boolean | false if changing this hierarchy is not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | addRootGraph | ||
| Description |
Adds a root graph. | ||
| Parameters | osid.id.Id | graphId | the Id of a graph |
| Errors | ALREADY_EXISTS | graphId is already in hierarchy | |
| NOT_FOUND | graphId not found | ||
| NULL_ARGUMENT | graphId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeRootGraph | ||
| Description |
Removes a root graph. | ||
| Parameters | osid.id.Id | graphId | the Id of a graph |
| Errors | NOT_FOUND | graphId not a root | |
| NULL_ARGUMENT | graphId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildGraph | ||
| Description |
Adds a child to a graph. | ||
| Parameters | osid.id.Id | graphId | the Id of a graph |
osid.id.Id | childId | the Id of the new child | |
| Errors | ALREADY_EXISTS | graphId is already a parent of childId | |
| NOT_FOUND | graphId or childId not found | ||
| NULL_ARGUMENT | graphId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildGraph | ||
| Description |
Removes a child from a graph. | ||
| Parameters | osid.id.Id | graphId | the Id of a graph |
osid.id.Id | childId | the Id of the new child | |
| Errors | NOT_FOUND | graphId not a parent of childId | |
| NULL_ARGUMENT | graphId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildGraphs | ||
| Description |
Removes all children from a graph. | ||
| Parameters | osid.id.Id | graphId | the Id of a graph |
| Errors | NOT_FOUND | graphId not in hierarchy | |
| NULL_ARGUMENT | graphId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |