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

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

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

MethodcanSearchMaps
Description

Tests if this user can perform Map searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetMapQuery
Description

Gets a map query.

Returnosid.mapping.MapQuerythe map query
CompliancemandatoryThis method must be implemented.
MethodgetMapsByQuery
Description

Gets a list of Maps matching the given map query.

Parametersosid.mapping.MapQuerymapQuerythe map query
Returnosid.mapping.MapListthe returned MapList
ErrorsNULL_ARGUMENT mapQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED mapQuery is not of this service
CompliancemandatoryThis method must be implemented.