OSID Logo
OSID Specifications
hierarchy package
Version 3.1.0
Interfaceosid.hierarchy.HierarchySearchResults
Implementsosid.OsidSearchResults
Used Byosid.hierarchy.HierarchySearchSession
Description

This interface provides a means to capture results of a search.

MethodgetHierarchies
Description

Gets the hierarchy list resulting from the search.

Returnosid.hierarchy.HierarchyList the hierarchy list
ErrorsILLEGAL_STATE the hierarchy list was already retrieved
Compliancemandatory This method must be implemented.
MethodgetHierarchyQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.hierarchy.HierarchyQueryInspector the hierarchy query inspector
Compliancemandatory This method must be implemented.
MethodgetHierarchySearchResultsRecord
Description

Gets the hierarchy search results record corresponding to the given hierarchy search record Type .This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypehierarchySearchRecordType a hierarchy search record type
Returnosid.hierarchy.records.HierarchySearchResultsRecord the hierarchy search results record
ErrorsNULL_ARGUMENT hierarchySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(hierarchySearchRecordType) is false
Compliancemandatory This method must be implemented.