OSID Logo
OSID Specifications
dictionary package
Version 3.1.0
Interfaceosid.dictionary.DictionarySearch
Implementsosid.OsidSearch
Used Byosid.dictionary.DictionarySearchSession
Description

This interface defines search options.

MethodsearchAmongDictionaries
Description

Execute this search among the given list of dictionaries.

Parametersosid.id.IdListdictionaryIds list of dictionaries
ErrorsNULL_ARGUMENT dictionaryIds is null
Compliancemandatory This method must be implemented.
MethodorderDictionaryResults
Description

Specify an ordering to the search results.

Parametersosid.dictionary.DictionarySearchOrderdictionarySearchOrder dictionary search order
ErrorsNULL_ARGUMENT dictionarySearchOrder is null
UNSUPPORTED dictionarySearchOrder is not of this service
Compliancemandatory This 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.TypedictionarySearchRecordType a dictionary search record type
Returnosid.dictionary.records.DictionarySearchRecord the dictionary search record
ErrorsNULL_ARGUMENT dictionarySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(dictionarySearchRecordType) is false
Compliancemandatory This method must be implemented.