OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.MapSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetMaps
Description

Gets the map list resulting from a search.

Returnosid.mapping.MapListthe map list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetMapQueryInspector
Description

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

Returnosid.mapping.MapQueryInspectorthe map query inspector
CompliancemandatoryThis 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.TypemapSearchRecordTypea map search record type
Returnosid.mapping.records.MapSearchResultsRecordthe map search results record
ErrorsNULL_ARGUMENT mapSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(mapSearchRecordType) is false
CompliancemandatoryThis method must be implemented.