Interface ObstacleLookupSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface ObstacleLookupSession extends OsidSession

This session defines methods for retrieving obstacle.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated map view: All obstacle methods in this session operate, retrieve and pertain to obstacles defined explicitly in the current map. Using an isolated view is useful for managing Obstacles with the ObstacleAdminSession .
  • federated map view: All obstacle lookup methods in this session operate, retrieve and pertain to all obstacle defined in this map and any other obstacle implicitly available in this map through map inheritence.
  • active obstacle view: All obstacle lookup methods return active obstacles.
  • any status obstacle view: Obstacles of any active or inactive status are returned from methods.

The methods useFederatedMapView() and useIsolatedMapView() behave as a radio group and one should be selected before invoking any lookup methods.

Obstacles may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Obstacles .

  • Method Details

    • getMapId

      Id getMapId()
      Gets the Map Id associated with this session.
      Returns:
      the Map Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getMap

      Map getMap() throws OperationFailedException, PermissionDeniedException
      Gets the Map associated with this session.
      Returns:
      the map
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupObstacles

      boolean canLookupObstacles()
      Tests if this user can perform Obstacle lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeObstacleView

      void useComparativeObstacleView()
      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.

    • usePlenaryObstacleView

      void usePlenaryObstacleView()
      A complete view of the Obstacle returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • useFederatedMapView

      void useFederatedMapView()
      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.

    • useIsolatedMapView

      void useIsolatedMapView()
      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.

    • useActiveObstacleView

      void useActiveObstacleView()
      Only active obstacles are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusObstacleView

      void useAnyStatusObstacleView()
      All active and inactive obstacles are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getObstacle

      Obstacle getObstacle(Id obstacleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Obstacle specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Obstacle may have a different Id than requested, such as the case where a duplicate Id was assigned to an Obstacle and retained for compatibility. In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned.
      Parameters:
      obstacleId - the Id of the Obstacle to retrieve
      Returns:
      the returned Obstacle
      Throws:
      NotFoundException - no Obstacle found with the given Id
      NullArgumentException - obstacleId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getObstaclesByIds

      ObstacleList getObstaclesByIds(IdList obstacleIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets an ObstacleList corresponding to the given IdList . In plenary mode, the returned list contains all of the obstacles specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Obstacles may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned.
      Parameters:
      obstacleIds - the list of Ids to retrieve
      Returns:
      the returned Obstacle list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - obstacleIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getObstaclesByGenusType

      ObstacleList getObstaclesByGenusType(Type obstacleGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an ObstacleList corresponding to the given obstacle genus Type which does not include obstacles of types derived from the specified Type . In plenary mode, the returned list contains all known obstacles or an error obstacles 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:
      obstacleGenusType - an obstacle genus type
      Returns:
      the returned Obstacle list
      Throws:
      NullArgumentException - obstacleGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getObstaclesByParentGenusType

      ObstacleList getObstaclesByParentGenusType(Type obstacleGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an ObstacleList corresponding to the given obstacle genus Type and include any additional obstacles with genus types derived from the specified Type . 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:
      obstacleGenusType - an obstacle genus type
      Returns:
      the returned Obstacle list
      Throws:
      NullArgumentException - obstacleGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getObstaclesByRecordType

      ObstacleList getObstaclesByRecordType(Type obstacleRecordType) throws OperationFailedException, PermissionDeniedException
      Gets an ObstacleList containing the given obstacle record Type . In plenary mode, the returned list contains all known obstacle 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:
      obstacleRecordType - an obstacle record type
      Returns:
      the returned Obstacle list
      Throws:
      NullArgumentException - obstacleRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getObstaclesForPath

      ObstacleList getObstaclesForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
      Gets an ObstacleList containing the given path. 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:
      pathId - a path Id
      Returns:
      the returned Obstacle list
      Throws:
      NullArgumentException - pathId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getObstaclesForPathAtCoordinate

      ObstacleList getObstaclesForPathAtCoordinate(Id pathId, Coordinate coordinate, Distance distance) throws OperationFailedException, PermissionDeniedException
      Gets an ObstacleList containing the given path between the given coordinates inclusive. 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:
      pathId - a path Id
      coordinate - starting coordinate
      distance - a distance from coordinate
      Returns:
      the returned Obstacle list
      Throws:
      NullArgumentException - pathId, coordinate or distance is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getObstacles

      ObstacleList getObstacles() throws OperationFailedException, PermissionDeniedException
      Gets all Obstacles . 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.
      Returns:
      a list of Obstacles
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.