| Interface | osid.mapping.path.rules.SpeedZoneEnablerRuleApplicationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | 
                 This session provides methods to apply   | ||
| Method | getMapId | ||
| Description | 
                     Gets the   | ||
| Return | osid.id.Id | the  Map Id  associated with this session  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMap | ||
| Description | 
                     Gets the   | ||
| Return | osid.mapping.Map | the map | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignSpeedZoneEnablers | ||
| 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   | ||
| Return | boolean |  false  if mapping is not authorized,  true  
otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | assignSpeedZoneEnablerToSpeedZone | ||
| Description | 
                     Adds an existing   | ||
| Parameters | osid.id.Id | speedZoneEnablerId | the  Id  of the  SpeedZoneEnabler   | 
osid.id.Id | speedZoneId | the  Id  of the  SpeedZone   | |
| Errors | ALREADY_EXISTS |  speedZoneEnablerId  is already applied to  speedZoneId 
  |                 |
| NOT_FOUND |  speedZoneEnablerId  or  speedZoneId  not found  |                 ||
| NULL_ARGUMENT |  speedZoneEnablerId  or  speed zoneId  is  
null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignSpeedZoneEnablerFromSpeedZone | ||
| Description | 
                     Removes a   | ||
| Parameters | osid.id.Id | speedZoneEnablerId | the  Id  of the  SpeedZoneEnabler   | 
osid.id.Id | speedZoneId | the  Id  of the  SpeedZone   | |
| Errors | NOT_FOUND |  speedZoneEnablerId  or  speedZoneId  not found 
or  speedZoneEnablerId  not applied to  speedZoneId   |                 |
| NULL_ARGUMENT |  speedZoneEnablerId  or  speed zoneId  is  
null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSequenceSpeedZoneEnablers | ||
| Description | 
                     Tests if this user can order   | ||
| Return | boolean |  false  if  SpeedZoneEnabler  ordering is not 
authorized,  true  otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | moveSpeedZoneEnablerAhead | ||
| Description | 
                     Reorders speed zone enablers for a speed zone by moving the specified speed zone enabler in front of a reference speed zone enabler.  | ||
| Parameters | osid.id.Id | speedZoneEnablerId | the  Id  of a  SpeedZoneEnabler   | 
osid.id.Id | speedZoneId | the  Id  of a  SpeedZone   | |
osid.id.Id | referenceId | the reference speed zone enabler  Id   | |
| Errors | NOT_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_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveSpeedZoneEnablerBehind | ||
| Description | 
                     Reorders speed zone enablers for a speed zone by moving the specified speed zone enabler behind a reference speed zone enabler.  | ||
| Parameters | osid.id.Id | speedZoneEnablerId | the  Id  of a  SpeedZoneEnabler   | 
osid.id.Id | speedZoneId | the  Id  of a  SpeedZone   | |
osid.id.Id | referenceId | the reference speed zone enabler  Id   | |
| Errors | NOT_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_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | orderSpeedZoneEnablers | ||
| Description | 
                     Reorders a set of speed zone enablers for a speed zone.  | ||
| Parameters | osid.id.Id[] | speedZoneEnablerIds | the  Ids  for a set of  SpeedZoneEnablers   | 
osid.id.Id | speedZoneId | the  Id  of a  SpeedZone   | |
| Errors | NOT_FOUND |  speedZoneId  not found or, an  speedZoneEnablerId 
 not related to  speedZoneId   |                 |
| NULL_ARGUMENT |  speedZoneEnablerIds  or  speedZoneId  is  
null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |