Interface | osid.mapping.path.ObstacleLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving obstacle. This lookup session defines several views:
The methods Obstacles may have an additional records indicated by
their respective record types. The record may not be accessed
through a cast of 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 | canLookupObstacles | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeObstacleView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryObstacleView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedMapView | ||
Description |
Federates the view for methods in this session. A federated view will include obstacle 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 retrievals to this map only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useActiveObstacleView | ||
Description |
Only active obstacles are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusObstacleView | ||
Description |
All active and inactive obstacles are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getObstacle | ||
Description |
Gets the In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned. | ||
Parameters | osid.id.Id | obstacleId | the Id of the Obstacle to retrieve |
Return | osid.mapping.path.Obstacle | the returned Obstacle | |
Errors | NOT_FOUND | no Obstacle found with the given Id | |
NULL_ARGUMENT | obstacleId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getObstaclesByIds | ||
Description |
Gets an In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned. | ||
Parameters | osid.id.IdList | obstacleIds | the list of Ids to retrieve |
Return | osid.mapping.path.ObstacleList | the returned Obstacle list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | obstacleIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getObstaclesByGenusType | ||
Description |
Gets an In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned. | ||
Parameters | osid.type.Type | obstacleGenusType | an obstacle genus type |
Return | osid.mapping.path.ObstacleList | the returned Obstacle list | |
Errors | NULL_ARGUMENT | obstacleGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getObstaclesByParentGenusType | ||
Description |
Gets an In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned. | ||
Parameters | osid.type.Type | obstacleGenusType | an obstacle genus type |
Return | osid.mapping.path.ObstacleList | the returned Obstacle list | |
Errors | NULL_ARGUMENT | obstacleGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getObstaclesByRecordType | ||
Description |
Gets an In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned. | ||
Parameters | osid.type.Type | obstacleRecordType | an obstacle record type |
Return | osid.mapping.path.ObstacleList | the returned Obstacle list | |
Errors | NULL_ARGUMENT | obstacleRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getObstaclesForPath | ||
Description |
Gets an In plenary mode, the returned list contains all known obstacles or an error results. Otherwise, the returned list may contain only those obstacles that are accessible through this session. In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned. | ||
Parameters | osid.id.Id | pathId | a path Id |
Return | osid.mapping.path.ObstacleList | the returned Obstacle list | |
Errors | NULL_ARGUMENT | pathId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getObstaclesForPathAtCoordinate | ||
Description |
Gets an In plenary mode, the returned list contains all known obstacles or an error results. Otherwise, the returned list may contain only those obstacles that are accessible through this session. In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned. | ||
Parameters | osid.id.Id | pathId | a path Id |
osid.mapping.Coordinate | coordinate | starting coordinate | |
osid.mapping.Distance | distance | a distance from coordinate | |
Return | osid.mapping.path.ObstacleList | the returned Obstacle list | |
Errors | NULL_ARGUMENT | pathId, coordinate or distance is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getObstacles | ||
Description |
Gets all In plenary mode, the returned list contains all known obstacles or an error results. Otherwise, the returned list may contain only those obstacles that are accessible through this session. In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned. | ||
Return | osid.mapping.path.ObstacleList | a list of Obstacles | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |