OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.MapSearchSession
Implementsosid.mapping.MapQuerySession
Description

This session provides methods for searching among Map objects. The search query is constructed using the MapQuery.

getMapsByQuery() is the basic search method and returns a list of Maps. A more advanced search may be performed with getMapsBySearch(). It accepts a MapSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getMapsBySearch() returns a MapSearchResults that can be used to access the resulting MapList or be used to perform a search within the result set through MapSearch.

Maps may have a query record indicated by their respective record types. The query record is accessed via the MapQuery.

MethodgetMapSearch
Description

Gets a map search.

Returnosid.mapping.MapSearchthe map search
CompliancemandatoryThis method must be implemented.
MethodgetMapSearchOrder
Description

Gets a map search order. The MapSearchOrder is supplied to a MapSearch to specify the ordering of results.

Returnosid.mapping.MapSearchOrderthe map search order
CompliancemandatoryThis method must be implemented.
MethodgetMapsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.mapping.MapQuerymapQuerythe map query
osid.mapping.MapSearchmapSearchthe map search
Returnosid.mapping.MapSearchResultsthe returned search results
ErrorsNULL_ARGUMENT mapQuery or mapSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED mapQuery or mapSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetMapQueryFromInspector
Description

Gets a map query from an inspector. The inspector is available from a MapSearchResults.

Parametersosid.mapping.MapQueryInspectormapQueryInspectora map query inspector
Returnosid.mapping.MapQuerythe map query
ErrorsNULL_ARGUMENT mapQueryInspector is null
UNSUPPORTED mapQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.