OSID Logo
OSID Specifications
hierarchy package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hierarchy.HierarchySearchOrder
Implementsosid.OsidCatalogSearchOrder
Description

An interface for specifying the ordering of search results.

MethodgetHierarchySearchOrderRecord
Description

Gets the hierarchy search order record corresponding to the given hierarchy record Type. Multiple retrievals return the same underlying object.

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