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

This session manages queries and sequencing to create "smart" dynamic catalogs. A SpeedZoneQuery can be retrieved from this session and mapped to this Map to create a virtual collection of SpeedZones. The speed zones may be sequenced using the SpeedZoneSearchOrder from this session.

This Map has a default query that matches any speed zone and a default search order that specifies no sequencing. The queries may be examined using a SpeedZoneQueryInspector. The query may be modified by converting the inspector back to a SpeedZoneQuery.

MethodgetMapId
Description

Gets the Map Id associated with this session.

Returnosid.id.Idthe Map Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetMap
Description

Gets the Map associated with this session.

Returnosid.mapping.Mapthe map
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartMaps
Description

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

Returnboolean false if smart map management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneQuery
Description

Gets a speed zone query.

Returnosid.mapping.path.SpeedZoneQuerythe speed zone query
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneSearchOrder
Description

Gets a speed zone search order.

Returnosid.mapping.path.SpeedZoneSearchOrderthe speed zone search order
CompliancemandatoryThis method must be implemented.
MethodapplySpeedZoneQuery
Description

Applies a speed zone query to this map.

Parametersosid.mapping.path.SpeedZoneQueryspeedZoneQuerythe speed zone query
ErrorsNULL_ARGUMENT speedZoneQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED speedZoneQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspecSpeedZoneQuery
Description

Gets a speed zone query inspector for this map.

Returnosid.mapping.path.SpeedZoneQueryInspectorthe speed zone query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplySpeedZoneSequencing
Description

Applies a speed zone search order to this map.

Parametersosid.mapping.path.SpeedZoneSearchOrderspeedZoneSearchOrderthe speed zone search order
ErrorsNULL_ARGUMENT speedZoneSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED speedZoneSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneQueryFromInspector
Description

Gets a speed zone query from an inspector.

Parametersosid.mapping.path.SpeedZoneQueryInspectorspeedZoneQueryInspectora speed zone query inspector
Returnosid.mapping.path.SpeedZoneQuerythe speed zone query
ErrorsNULL_ARGUMENT speedZoneQueryInspector is null
UNSUPPORTED speedZoneQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.