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

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

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.
MethodcanAssignSpeedZoneEnablers
Description

Tests if this user can alter speed zone enabler/speed zone mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignSpeedZoneEnablerToSpeedZone
Description

Adds an existing SpeedZoneEnabler to a SpeedZone.

Parametersosid.id.IdspeedZoneEnablerIdthe Id of the SpeedZoneEnabler
osid.id.IdspeedZoneIdthe Id of the SpeedZone
ErrorsALREADY_EXISTS speedZoneEnablerId is already applied to speedZoneId
NOT_FOUND speedZoneEnablerId or speedZoneId not found
NULL_ARGUMENT speedZoneEnablerId or speed zoneId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignSpeedZoneEnablerFromSpeedZone
Description

Removes a SpeedZoneEnabler from a SpeedZone.

Parametersosid.id.IdspeedZoneEnablerIdthe Id of the SpeedZoneEnabler
osid.id.IdspeedZoneIdthe Id of the SpeedZone
ErrorsNOT_FOUND speedZoneEnablerId or speedZoneId not found or speedZoneEnablerId not applied to speedZoneId
NULL_ARGUMENT speedZoneEnablerId or speed zoneId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceSpeedZoneEnablers
Description

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

Returnboolean false if SpeedZoneEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveSpeedZoneEnablerAhead
Description

Reorders speed zone enablers for a speed zone by moving the specified speed zone enabler in front of a reference speed zone enabler.

Parametersosid.id.IdspeedZoneEnablerIdthe Id of a SpeedZoneEnabler
osid.id.IdspeedZoneIdthe Id of a SpeedZone
osid.id.IdreferenceIdthe reference speed zone enabler Id
ErrorsNOT_FOUND speedZoneEnablerId, speed zoneId, or referenceId not found or, speedZoneEnablerId or referenceId not related to speedZoneId
NULL_ARGUMENT speedZoneEnablerId, speed zoneId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveSpeedZoneEnablerBehind
Description

Reorders speed zone enablers for a speed zone by moving the specified speed zone enabler behind a reference speed zone enabler.

Parametersosid.id.IdspeedZoneEnablerIdthe Id of a SpeedZoneEnabler
osid.id.IdspeedZoneIdthe Id of a SpeedZone
osid.id.IdreferenceIdthe reference speed zone enabler Id
ErrorsNOT_FOUND speedZoneEnablerId, speed zoneId, or referenceId not found or, speedZoneEnablerId or referenceId not related to speedZoneId
NULL_ARGUMENT speedZoneEnablerId, speed zoneId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderSpeedZoneEnablers
Description

Reorders a set of speed zone enablers for a speed zone.

Parametersosid.id.Id[]speedZoneEnablerIdsthe Ids for a set of SpeedZoneEnablers
osid.id.IdspeedZoneIdthe Id of a SpeedZone
ErrorsNOT_FOUND speedZoneId not found or, an speedZoneEnablerId not related to speedZoneId
NULL_ARGUMENT speedZoneEnablerIds or speedZoneId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.