| Interface | osid.mapping.path.rules.ObstacleEnablerMapAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | 
                 This session provides methods to re-assign   Adding a reference of an   | ||
| Method | canAssignObstacleEnablers | ||
| Description | 
                     Tests if this user can alter obstacle 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 | canAssignObstacleEnablersToMap | ||
| Description | 
                     Tests if this user can alter obstacle 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 maps including and under the given map node in which any obstacle 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 | getAssignableMapIdsForObstacleEnabler | ||
| Description | 
                     Gets a list of maps including and under the given map node in which a specific obstacle enabler can be assigned.  | ||
| Parameters | osid.id.Id | mapId | the  Id  of the  Map   | 
osid.id.Id | obstacleEnablerId | the  Id  of the  ObstacleEnabler   | |
| Return | osid.id.IdList | list of assignable map  Ids   | |
| Errors | NULL_ARGUMENT |  mapId  or  obstacleEnablerId  is  null 
  |                 |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignObstacleEnablerToMap | ||
| Description | 
                     Adds an existing   | ||
| Parameters | osid.id.Id | obstacleEnablerId | the  Id  of the  ObstacleEnabler   | 
osid.id.Id | mapId | the  Id  of the  Map   | |
| Errors | ALREADY_EXISTS |  obstacleEnablerId  is already assigned to  mapId 
  |                 |
| NOT_FOUND |  obstacleEnablerId  or  mapId  not found  |                 ||
| NULL_ARGUMENT |  obstacleEnablerId  or  mapId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignObstacleEnablerFromMap | ||
| Description | 
                     Removes an   | ||
| Parameters | osid.id.Id | obstacleEnablerId | the  Id  of the  ObstacleEnabler   | 
osid.id.Id | mapId | the  Id  of the  Map   | |
| Errors | NOT_FOUND |  obstacleEnablerId  or  mapId  not found or 
 obstacleEnablerId  not assigned to  mapId   |                 |
| NULL_ARGUMENT |  obstacleEnablerId  or  mapId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |