OSID Logo
OSID Specifications
hierarchy package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hierarchy.HierarchyQueryInspector
Implementsosid.OsidCatalogQueryInspector
Description

This is the query inspector for examining hierarchy queries.

MethodgetNodeIdTerms
Description

Gets the node Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetHierarchyQueryInspectorRecord
Description

Gets the hierarchy query inspector record corresponding to the given Hierarchy record Type.

Parametersosid.type.TypehierarchyRecordTypea hierarchy record type
Returnosid.hierarchy.records.HierarchyQueryInspectorRecordthe hierarchy query inspector record
ErrorsNULL_ARGUMENT hierarchyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(hierarchyRecordType) is false
CompliancemandatoryThis method must be implemented.