OSID Logo
OSID Specifications
search package
Version 3.0.0
Release Candidate Preview
Interfaceosid.search.SearchOrder
Implementsosid.OsidSearchOrder
Description

An interface for specifying the ordering of search results.

MethodgetSearchOrderRecord
Description

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

Parametersosid.type.TypequeryRecordTypea query record type
Returnosid.search.records.SearchOrderRecordthe search order record
ErrorsNULL_ARGUMENT queryRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(queryRecordType) is false
CompliancemandatoryThis method must be implemented.