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

This session provides methods to retrieve SpeedZoneEnabler to SpeedZone mappings. a SpeedZone with multiple SpeedZoneEnablers means any positive rule evaluation across the enablers result in an effective SpeedZone.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated map view: All methods in this session operate, retrieve and pertain speed zone enablers defined explicitly in the current map
  • federated map view: All methods in this session operate, retrieve and pertain to all speed zone enablers defined in this map and any other speed zone enablers implicitly available in this map through map inheritence.
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.
MethodcanLookupSpeedZoneEnablerRules
Description

Tests if this user can perform lookups of speed zone enabler/speed zone mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeSpeedZoneEnablerRuleView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenarySpeedZoneEnablerRuleView
Description

A complete view of the SpeedZoneEnabler and SpeedZone returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

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

Gets the SpeedZoneEnabler Id associated with a SpeedZone.

Parametersosid.id.Id speedZoneId Id of the SpeedZone
Returnosid.id.IdListthe speed zone enabler Ids
ErrorsNOT_FOUND speedZoneId is not found
NULL_ARGUMENT speedZoneId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneEnablersForSpeedZone
Description

Gets the SpeedZoneEnablers associated with a SpeedZone.

Parametersosid.id.IdspeedZoneId Id of the SpeedZone
Returnosid.mapping.path.rules.SpeedZoneEnablerListthe speed zone enablers
ErrorsNOT_FOUND speedZoneId is not found
NULL_ARGUMENT speedZoneId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneIdsForSpeedZoneEnabler
Description

Gets the SpeedZone Ids mapped to a SpeedZoneEnabler.

Parametersosid.id.IdspeedZoneEnablerId Id of a SpeedZoneEnabler
Returnosid.id.IdListlist of speed zone Ids
ErrorsNOT_FOUND speedZoneEnablerId is not found
NULL_ARGUMENT speedZoneEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZonesForSpeedZoneEnabler
Description

Gets the SpeedZones mapped to a SpeedZoneEnabler.

Parametersosid.id.IdspeedZoneEnablerId Id of a SpeedZoneEnabler
Returnosid.mapping.path.SpeedZoneListlist of speed zones
ErrorsNOT_FOUND speedZoneEnablerId is not found
NULL_ARGUMENT speedZoneEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.