OSID Logo
OSID Specifications
dictionary package
Version 3.1.0
Interfaceosid.dictionary.EntrySearchResults
Implementsosid.OsidSearchResults
Used Byosid.dictionary.EntrySearchSession
Description

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

MethodgetEntries
Description

Gets the entry list resulting from the search.

Returnosid.dictionary.EntryList the entry list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetEntryQueryInspector
Description

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

Returnosid.dictionary.EntryQueryInspector the entry query inspector
Compliancemandatory This method must be implemented.
MethodgetEntrySearchResultsRecord
Description

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

Parametersosid.type.TypeentrySearchRecordType an entry search record type
Returnosid.dictionary.records.EntrySearchResultsRecord the entry search results record
ErrorsNULL_ARGUMENT entrySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(entrySearchRecordType) is false
Compliancemandatory This method must be implemented.