OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.PathSearchOrder
Implementsosid.OsidObjectSearchOrder
Description

An interface for specifying the ordering of search results.

MethodgetPathSearchOrderRecord
Description

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

Parametersosid.type.TypepathRecordTypea path record type
Returnosid.mapping.path.records.PathSearchOrderRecordthe path search order record
ErrorsNULL_ARGUMENT pathRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(pathRecordType) is false
CompliancemandatoryThis method must be implemented.