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

This session provides methods to re-assign SpeedZoneEnabler to Map mappings. a SpeedZoneEnabler may appear in multiple Map objects and removing the last reference to a SpeedZoneEnabler is the equivalent of deleting it. Each Map may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a SpeedZoneEnabler to another Map is not a copy operation (eg: does not change its Id ).

MethodcanAssignSpeedZoneEnablers
Description

Tests if this user can alter speed zone enabler/map 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.
MethodcanAssignSpeedZoneEnablersToMap
Description

Tests if this user can alter speed zone enabler/map 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.

Parametersosid.id.IdmapIdthe Id of the Map
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT mapId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableMapIds
Description

Gets a list of map including and under the given map node in which any speed zone enabler can be assigned.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.id.IdListlist of assignable map Ids
ErrorsNULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableMapIdsForSpeedZoneEnabler
Description

Gets a list of map including and under the given map node in which a specific speed zone enabler can be assigned.

Parametersosid.id.IdmapIdthe Id of the Map
osid.id.IdspeedZoneEnablerIdthe Id of the SpeedZoneEnabler
Returnosid.id.IdListlist of assignable map Ids
ErrorsNULL_ARGUMENT mapId or speedZoneEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignSpeedZoneEnablerToMap
Description

Adds an existing SpeedZoneEnabler to an Map.

Parametersosid.id.IdspeedZoneEnablerIdthe Id of the SpeedZoneEnabler
osid.id.IdmapIdthe Id of the Map
ErrorsALREADY_EXISTS speedZoneEnablerId is already assigned to mapId
NOT_FOUND speedZoneEnablerId or mapId not found
NULL_ARGUMENT speedZoneEnablerId or mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignSpeedZoneEnablerFromMap
Description

Removes a SpeedZoneEnabler from an Map.

Parametersosid.id.IdspeedZoneEnablerIdthe Id of the SpeedZoneEnabler
osid.id.IdmapIdthe Id of the Map
ErrorsNOT_FOUND speedZoneEnablerId or mapId not found or speedZoneEnablerId not assigned to mapId
NULL_ARGUMENT speedZoneEnablerId or mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.