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

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

MethodgetLocations
Description

Gets the location list resulting from a search.

Returnosid.mapping.LocationListthe location list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetLocationQueryInspector
Description

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

Returnosid.mapping.LocationQueryInspectorthe location query inspector
CompliancemandatoryThis 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.TypelocationSearchRecordTypea location search record type
Returnosid.mapping.records.LocationSearchResultsRecordthe location search results record
ErrorsNULL_ARGUMENT locationSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(locationSearchRecordType) is false
CompliancemandatoryThis method must be implemented.