OSID Logo
OSID Specifications
dictionary package
Version 3.0.0
Release Candidate Preview
Interfaceosid.dictionary.DictionarySearch
Implementsosid.OsidSearch
Description

This interface defines search options.

MethodsearchAmongDictionaries
Description

Execute this search among the given list of dictionaries.

Parametersosid.id.IdListdictionaryIdslist of dictionaries
ErrorsNULL_ARGUMENT dictionaryIds is null
CompliancemandatoryThis method must be implemented.
MethodorderDictionaryResults
Description

Specify an ordering to the search results.

Parametersosid.dictionary.DictionarySearchOrderdictionarySearchOrderdictionary search order
ErrorsNULL_ARGUMENT dictionarySearchOrder is null
UNSUPPORTED dictionarySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetDictionarySearchRecord
Description

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

Parametersosid.type.TypedictionarySearchRecordTypea dictionary search record type
Returnosid.dictionary.records.DictionarySearchRecordthe dictionary search record
ErrorsNULL_ARGUMENT dictionarySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(dictionarySearchRecordType) is false
CompliancemandatoryThis method must be implemented.