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

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

This session defines views that offer differing behaviors for searching.

  • federated map view: searches include speed zone enablers in map of which this map is an ancestor in the map hierarchy
  • isolated map view: searches are restricted to speed zone enablers in this map

Speed zone enablers may have a query record indicated by their respective record types. The query record is accessed via the 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.
MethodcanSearchSpeedZoneEnablers
Description

Tests if this user can perform SpeedZoneEnabler lookups. 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.
MethoduseFederatedMapView
Description

Federates the view for methods in this session. A federated view will include speed zone enablers in maps which are children of this speed zone in the map hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedMapView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this map only.

CompliancemandatoryThis method is 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.
MethodgetSpeedZoneEnablersByQuery
Description

Gets a list of SpeedZoneEnablers matching the given speed zone enabler query.

Parametersosid.mapping.path.rules.SpeedZoneEnablerQueryspeedZoneEnablerQuerythe sespeed zone enabler query
Returnosid.mapping.path.rules.SpeedZoneEnablerListthe returned SpeedZoneEnablerList
ErrorsNULL_ARGUMENT speedZoneEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED speedZoneEnablerQuery is not of this service
CompliancemandatoryThis method must be implemented.