OSID Logo
OSID Specifications
mapping package
Version 3.1.0
Interfaceosid.mapping.MapSearch
Implementsosid.OsidSearch
Used Byosid.mapping.MapSearchSession
Description

The search interface for governing map searches.

MethodsearchAmongMaps
Description

Execute this search among the given list of maps.

Parametersosid.id.IdListmapIds list of maps
ErrorsNULL_ARGUMENT mapIds is null
Compliancemandatory This method must be implemented.
MethodorderMapResults
Description

Specify an ordering to the search results.

Parametersosid.mapping.MapSearchOrdermapSearchOrder map search order
ErrorsNULL_ARGUMENT mapSearchOrder is null
UNSUPPORTED mapSearchOrder is not of this service
Compliancemandatory This 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.TypemapSearchRecordType a map search record type
Returnosid.mapping.records.MapSearchRecord the map search record
ErrorsNULL_ARGUMENT mapSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(mapSearchRecordType) is false
Compliancemandatory This method must be implemented.