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

This session provides methods to re-assign SpeedZones to Map objects A SpeedZone may appear in multiple Map objects and removing the last reference to a SpeedZone 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 SpeedZone to another Map is not a copy operation (eg: does not change its Id ).

MethodcanAssignSpeedZones
Description

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

Returnboolean false if speed zone is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignSpeedZonesToMap
Description

Tests if this user can alter speed zone/map mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known speed zone 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 assignment 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 maps including and under the given map node in which any speed zone 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.
MethodgetAssignableMapIdsForSpeedZone
Description

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

Parametersosid.id.IdmapIdthe Id of the Map
osid.id.IdspeedZoneIdthe Id of the SpeedZone
Returnosid.id.IdListlist of assignable map Ids
ErrorsNULL_ARGUMENT mapId or speedZoneId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignSpeedZoneToMap
Description

Adds an existing SpeedZone to a Map.

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

Removes a SpeedZone from a Map.

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