Interface | osid.hold.OublietteHierarchyDesignSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for managing a hierarchy of
| ||
Method | getOublietteHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getOublietteHierarchy | ||
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 | canModifyOublietteHierarchy | ||
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 | addRootOubliette | ||
Description |
Adds a root oubliette. | ||
Parameters | osid.id.Id | oublietteId | the Id of an oubliette |
Errors | ALREADY_EXISTS | oublietteId is already in hierarchy | |
NOT_FOUND | oublietteId not found | ||
NULL_ARGUMENT | oublietteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeRootOubliette | ||
Description |
Removes a root oubliette. | ||
Parameters | osid.id.Id | oublietteId | the Id of an oubliette |
Errors | NOT_FOUND | oublietteId is not a root | |
NULL_ARGUMENT | oublietteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addChildOubliette | ||
Description |
Adds a child to an oubliette. | ||
Parameters | osid.id.Id | oublietteId | the Id of an oubliette |
osid.id.Id | childId | the Id of the new child | |
Errors | ALREADY_EXISTS | oublietteId is already a parent of childId | |
NOT_FOUND | oublietteId or childId not found | ||
NULL_ARGUMENT | oublietteId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildOubliette | ||
Description |
Removes a child from an oubliette. | ||
Parameters | osid.id.Id | oublietteId | the Id of an oubliette |
osid.id.Id | childId | the Id of the new child | |
Errors | NOT_FOUND | oublietteId is not parent of childId | |
NULL_ARGUMENT | oublietteId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildOubliettes | ||
Description |
Removes all children from an oubliette. | ||
Parameters | osid.id.Id | oublietteId | the Id of an oubliette |
Errors | NOT_FOUND | oublietteId is not found | |
NULL_ARGUMENT | oublietteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |