OSID Logo
OSID Specifications
hierarchy package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hierarchy.HierarchySearch
Implementsosid.OsidSearch
Description

HierarchySearch defines the interface for specifying hierarchy search options.

MethodsearchAmongHierarchies
Description

Execute this search using a given list of hierarchies.

Parametersosid.id.IdListhierarchyIdslist of hierarchies
ErrorsNULL_ARGUMENT hierarchyIds is null
CompliancemandatoryThis method must be implemented.
MethodorderHierarchyResults
Description

Specify an ordering to the search results.

Parametersosid.hierarchy.HierarchySearchOrderhierarchySearchOrderhierarchy search order
ErrorsNULL_ARGUMENT hierarchySearchOrder is null
UNSUPPORTED hierarchySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetHierarchySearchRecord
Description

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

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