OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.MapSearch
Implementsosid.OsidSearch
Description

The search interface for governing map searches.

MethodsearchAmongMaps
Description

Execute this search among the given list of maps.

Parametersosid.id.IdListmapIdslist of maps
ErrorsNULL_ARGUMENT mapIds is null
CompliancemandatoryThis method must be implemented.
MethodorderMapResults
Description

Specify an ordering to the search results.

Parametersosid.mapping.MapSearchOrdermapSearchOrdermap search order
ErrorsNULL_ARGUMENT mapSearchOrder is null
UNSUPPORTED mapSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetMapSearchRecord
Description

Gets the map search 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.MapSearchRecordthe map search record
ErrorsNULL_ARGUMENT mapSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(mapSearchRecordType) is false
CompliancemandatoryThis method must be implemented.