Interface | osid.mapping.path.ObstacleNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
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 | canRegisterForObstacleNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedMapView | ||
Description |
Federates the view for methods in this session. A federated view will include obstacles in maps which are children of this map in the map hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedMapView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this map only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewObstacles | ||
Description |
Register for notifications of new obstacles. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewObstaclesForPath | ||
Description |
Register for notifications of new obstacles. for the
given path. | ||
Parameters | osid.id.Id | pathId | the Id of the path to monitor |
Errors | NULL_ARGUMENT | pathId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedObstacles | ||
Description |
Registers for notification of updated obstacles. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedObstacle | ||
Description |
Registers for notification of an updated obstacle.
| ||
Parameters | osid.id.Id | obstacleId | the Id of the Obstacle to monitor |
Errors | NULL_ARGUMENT | obstacleId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedObstaclesForPath | ||
Description |
Registers for notification of updated obstacles along
the given path. | ||
Parameters | osid.id.Id | pathId | the Id of the Path to monitor |
Errors | NULL_ARGUMENT | pathId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedObstacles | ||
Description |
Registers for notification of deleted obstacles. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedObstacle | ||
Description |
Registers for notification of a deleted obstacle.
| ||
Parameters | osid.id.Id | obstacleId | the Id of the Obstacle to monitor |
Errors | NULL_ARGUMENT | obstacleId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedObstaclesForPath | ||
Description |
Registers for notification of deleted obstacleq for the
given path. | ||
Parameters | osid.id.Id | pathId | the Id of the path to monitor |
Errors | NULL_ARGUMENT | pathId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |