OSID Logo
OSID Specifications
hierarchy package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hierarchy.HierarchyQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching among Hierarchy objects. The search query is constructed using the HierarchyQuery.

Hierarchies may have a query record indicated by their respective record types. The query record is accessed via the HierarchuQuery.

MethodcanSearchHierarchies
Description

Tests if this user can perform Hierarchy searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetHierarchyQuery
Description

Gets a hierarchy query.

Returnosid.hierarchy.HierarchyQuerythe hierarchy query
CompliancemandatoryThis method must be implemented.
MethodgetHierarchiesByQuery
Description

Gets a list of Hierarchy objects matching the given hierarchy query.

Parametersosid.hierarchy.HierarchyQueryhierarchyQuerythe hierarchy query
Returnosid.hierarchy.HierarchyListthe returned HierarchyList
ErrorsNULL_ARGUMENT hierarchyQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED hierarchyQuery is not of this service
CompliancemandatoryThis method must be implemented.