Interface | osid.hierarchy.HierarchyQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among Hierarchies may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | canSearchHierarchies | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getHierarchyQuery | ||
Description |
Gets a hierarchy query. | ||
Return | osid.hierarchy.HierarchyQuery | the hierarchy query | |
Compliance | mandatory | This method must be implemented. | |
Method | getHierarchiesByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.hierarchy.HierarchyQuery | hierarchyQuery | the hierarchy query |
Return | osid.hierarchy.HierarchyList | the returned HierarchyList | |
Errors | NULL_ARGUMENT | hierarchyQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | hierarchyQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |