| Interface | osid.mapping.path.rules.SpeedZoneEnablerMapAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.mapping.path.rules.MappingPathRulesManager | ||
osid.mapping.path.rules.MappingPathRulesProxyManager | |||
| Description |
This session provides methods to re-assign
Adding a reference of a | ||
| Method | canAssignSpeedZoneEnablers | ||
| 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
| ||
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignSpeedZoneEnablersToMap | ||
| 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
| ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | mapId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableMapIds | ||
| Description |
Gets a list of map including and under the given map node in which any speed zone enabler can be assigned. | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.id.IdList | list of assignable map Ids | |
| Errors | NULL_ARGUMENT | mapId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableMapIdsForSpeedZoneEnabler | ||
| Description |
Gets a list of map including and under the given map node in which a specific speed zone enabler can be assigned. | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
osid.id.Id | speedZoneEnablerId | the Id of the SpeedZoneEnabler | |
| Return | osid.id.IdList | list of assignable map Ids | |
| Errors | NULL_ARGUMENT | mapId or speedZoneEnablerId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignSpeedZoneEnablerToMap | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | speedZoneEnablerId | the Id of the SpeedZoneEnabler |
osid.id.Id | mapId | the Id of the Map | |
| Errors | ALREADY_EXISTS | speedZoneEnablerId is already assigned to mapId | |
| NOT_FOUND | speedZoneEnablerId or mapId not found | ||
| NULL_ARGUMENT | speedZoneEnablerId or mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignSpeedZoneEnablerFromMap | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | speedZoneEnablerId | the Id of the SpeedZoneEnabler |
osid.id.Id | mapId | the Id of the Map | |
| Errors | NOT_FOUND | speedZoneEnablerId or mapId not found or
speedZoneEnablerId not assigned to mapId | |
| NULL_ARGUMENT | speedZoneEnablerId or mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignSpeedZoneEnablerToMap | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | speedZoneEnablerId | the Id of the SpeedZoneEnabler |
osid.id.Id | fromMapId | the Id of the current Map | |
osid.id.Id | toMapId | the Id of the destination Map | |
| Errors | ALREADY_EXISTS | speedZoneEnablerId already assigned to toMapId | |
| NOT_FOUND | speedZoneEnablerId, fromMapId , or toMapId not
found or speedZoneEnablerId not mapped to fromMapId | ||
| NULL_ARGUMENT | speedZoneEnablerId, fromMapId , or toMapId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |