OSID Logo
OSID Specifications
mapping package
Version 3.1.0
Interfaceosid.mapping.LocationSearchResults
Implementsosid.OsidSearchResults
Used Byosid.mapping.LocationSearchSession
Description

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

MethodgetLocations
Description

Gets the location list resulting from a search.

Returnosid.mapping.LocationList the location list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetLocationQueryInspector
Description

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

Returnosid.mapping.LocationQueryInspector the location query inspector
Compliancemandatory This method must be implemented.
MethodgetLocationSearchResultsRecord
Description

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

Parametersosid.type.TypelocationSearchRecordType a location search record type
Returnosid.mapping.records.LocationSearchResultsRecord the location search results record
ErrorsNULL_ARGUMENT locationSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(locationSearchRecordType) is false
Compliancemandatory This method must be implemented.