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

This session manages queries and sequencing to create "smart" dynamic map. a SpeedZoneEnablerQuery can be retrieved from this session and mapped to this Map to create a virtual collection of speed zone enablers. The speed zone enablers may be sequenced using the SpeedZoneEnablerSearchOrder from this session.

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

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 map. 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.
MethodgetSpeedZoneEnablerQuery
Description

Gets a speed zone enabler query.

Returnosid.mapping.path.rules.SpeedZoneEnablerQuerythe speed zone enabler query
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneEnablerSearchOrder
Description

Gets a speed zone enabler search order.

Returnosid.mapping.path.rules.SpeedZoneEnablerSearchOrderthe speed zone enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplySpeedZoneEnablerQuery
Description

Applies a speed zone enabler query to this map.

Parametersosid.mapping.path.rules.SpeedZoneEnablerQueryspeedZoneEnablerQuerythe speed zone enabler query
ErrorsNULL_ARGUMENT speedZoneEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED speedZoneEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectSpeedZoneEnablerQuery
Description

Gets a speed zone enabler query inspector for this map.

Returnosid.mapping.path.rules.SpeedZoneEnablerQueryInspectorthe speed zone enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplySpeedZoneEnablerSequencing
Description

Applies a speed zone enabler search order to this map.

Parametersosid.mapping.path.rules.SpeedZoneEnablerSearchOrderspeedZoneEnablerSearchOrderthe speed zone enabler search order
ErrorsNULL_ARGUMENT speedZoneEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED speedZoneEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneEnablerQueryFromInspector
Description

Gets a speed zone enabler query from an inspector.

Parametersosid.mapping.path.rules.SpeedZoneEnablerQueryInspectorspeedZoneEnablerQueryInspectora speed zone enabler query inspector
Returnosid.mapping.path.rules.SpeedZoneEnablerQuerythe speed zone enabler query
ErrorsNULL_ARGUMENT speedZoneEnablerQueryInspector is null
UNSUPPORTED speedZoneEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.