OSID Logo
OSID Specifications
dictionary package
Version 3.0.0
Release Candidate Preview
Interfaceosid.dictionary.DictionarySearchOrder
Implementsosid.OsidCatalogSearchOrder
Description

An interface for specifying the ordering of search results.

MethodgetDictionarySearchOrderRecord
Description

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

Parametersosid.type.TypedictionaryRecordTypea dictionary record type
Returnosid.dictionary.records.DictionarySearchOrderRecordthe dictionary search order record
ErrorsNULL_ARGUMENT dictionaryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(dictionaryRecordType) is false
CompliancemandatoryThis method must be implemented.