Interface | osid.mapping.MapHierarchyDesignSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for managing a hierarchy of
| ||
Method | getMapHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getMapHierarchy | ||
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 | canModifyMapHierarchy | ||
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 | addRootMap | ||
Description |
Adds a root map. | ||
Parameters | osid.id.Id | mapId | the Id of a map |
Errors | ALREADY_EXISTS | mapId is already in hierarchy | |
NOT_FOUND | mapId not found | ||
NULL_ARGUMENT | mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeRootMap | ||
Description |
Removes a root map. | ||
Parameters | osid.id.Id | mapId | the Id of a map |
Errors | NOT_FOUND | mapId is not a root | |
NULL_ARGUMENT | mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addChildMap | ||
Description |
Adds a child to a map. | ||
Parameters | osid.id.Id | mapId | the Id of a map |
osid.id.Id | childId | the Id of the new child | |
Errors | ALREADY_EXISTS | mapId is already a parent of childId | |
NOT_FOUND | mapId or childId not found | ||
NULL_ARGUMENT | mapId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildMap | ||
Description |
Removes a child from a map. | ||
Parameters | osid.id.Id | mapId | the Id of a map |
osid.id.Id | childId | the Id of the new child | |
Errors | NOT_FOUND | mapId is not parent of childId | |
NULL_ARGUMENT | mapId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildMaps | ||
Description |
Removes all children from a map. | ||
Parameters | osid.id.Id | mapId | the Id of a map |
Errors | NOT_FOUND | mapId is not found | |
NULL_ARGUMENT | mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |