OSID Logo
OSID Specifications
dictionary package
Version 3.0.0
Release Candidate Preview
Interfaceosid.dictionary.DictionarySearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetDictionaries
Description

Gets the dictionary list resulting from the search.

Returnosid.dictionary.DictionaryListthe dictionary list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetDictionaryQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.dictionary.DictionaryQueryInspectorthe dictionary query inspector
CompliancemandatoryThis method must be implemented.
MethodgetDictionarySearchResultsRecord
Description

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

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