OSID Logo
OSID Specifications
mapping package
Version 3.1.0
Interfaceosid.mapping.MapSearchResults
Implementsosid.OsidSearchResults
Used Byosid.mapping.MapSearchSession
Description

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

MethodgetMaps
Description

Gets the map list resulting from a search.

Returnosid.mapping.MapList the map list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetMapQueryInspector
Description

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

Returnosid.mapping.MapQueryInspector the map query inspector
Compliancemandatory This method must be implemented.
MethodgetMapSearchResultsRecord
Description

Gets the map search results record corresponding to the given map search record Type. This method must be used to retrieve an object implementing the requested record interface along with all of its ancestor interfaces.

Parametersosid.type.TypemapSearchRecordType a map search record type
Returnosid.mapping.records.MapSearchResultsRecord the map search results record
ErrorsNULL_ARGUMENT mapSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(mapSearchRecordType) is false
Compliancemandatory This method must be implemented.