OSID Specifications
hierarchy package
Version 3.1.0
hierarchy package
Version 3.1.0
| Interface | osid.hierarchy.HierarchySequencingSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.hierarchy.HierarchyManager | ||
osid.hierarchy.HierarchyProxyManager | |||
| Description |
This session provides methods to sequence the nodes in a hierarchy. | ||
| Method | getHierarchyId | ||
| Description |
Gets the hierarchy | ||
| Return | osid.id.Id | the hierarchy Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getHierarchy | ||
| 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 | canSequenceHierarchy | ||
| 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 | moveNodeAhead | ||
| Description |
Moves a node ahead of a refrence node under the given parent. | ||
| Parameters | osid.id.Id | parentId | the Id of the parent node |
osid.id.Id | referenceId | the Id of the node | |
osid.id.Id | id | the Id of the node to move ahead of referenceId | |
| Errors | NOT_FOUND | parentId, referenceId, or id not found, or
referenceId or id is not a child of
parentId | |
| NULL_ARGUMENT | parentId, referenceId, or id is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveNodeBehind | ||
| Description |
Moves a node behind a refrence node under the given parent. | ||
| Parameters | osid.id.Id | parentId | the Id of the parent node |
osid.id.Id | referenceId | the Id of the node | |
osid.id.Id | id | the Id of the node to move behind referenceId | |
| Errors | NOT_FOUND | parentId, referenceId, or id not found, or
referenceId or id is not a child of
parentId | |
| NULL_ARGUMENT | parentId, referenceId, or id is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | sequenceNodes | ||
| Description |
Sequences a set of nodes under a parent. | ||
| Parameters | osid.id.Id | parentId | the Id of the parent node |
osid.id.Id[] | ids | the Ids of the nodes | |
| Errors | NOT_FOUND | parentId or an id not found, or an
id is not a child of parentId | |
| NULL_ARGUMENT | parentId or ids is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |