Interface ObstacleSmartMapSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An ObstacleQuery can be retrieved from this session and mapped to this Map to create a virtual collection of Obstacles . The obstacle may be sequenced using the ObstacleSearchOrder from this session.

This Map has a default query that matches any obstacle and a default search order that specifies no sequencing. The queries may be examined using an ObstacleQueryInspector . The query may be modified by converting the inspector back to an ObstacleQuery .

  • 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.

    • canManageSmartMaps

      boolean canManageSmartMaps()
      Tests if this user can manage smart maps. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
      Returns:
      false if smart map management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getObstacleQuery

      ObstacleQuery getObstacleQuery()
      Gets an obstacle query.
      Returns:
      the obstacle query
      Compliance:
      mandatory - This method must be implemented.

    • getObstacleSearchOrder

      ObstacleSearchOrder getObstacleSearchOrder()
      Gets an obstacle search order.
      Returns:
      the obstacle search order
      Compliance:
      mandatory - This method must be implemented.

    • applyObstacleQuery

      void applyObstacleQuery(ObstacleQuery obstacleQuery) throws OperationFailedException, PermissionDeniedException
      Applies an obstacle query to this map.
      Parameters:
      obstacleQuery - the obstacle query
      Throws:
      NullArgumentException - obstacleQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - obstacleQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspecObstacleQuery

      ObstacleQueryInspector inspecObstacleQuery() throws OperationFailedException, PermissionDeniedException
      Gets an obstacle query inspector for this map.
      Returns:
      the obstacle query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyObstacleSequencing

      void applyObstacleSequencing(ObstacleSearchOrder obstacleSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies an obstacle search order to this map.
      Parameters:
      obstacleSearchOrder - the obstacle search order
      Throws:
      NullArgumentException - obstacleSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - obstacleSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getObstacleQueryFromInspector

      ObstacleQuery getObstacleQueryFromInspector(ObstacleQueryInspector obstacleQueryInspector)
      Gets an obstacle query from an inspector.
      Parameters:
      obstacleQueryInspector - an obstacle query inspector
      Returns:
      the obstacle query
      Throws:
      NullArgumentException - obstacleQueryInspector is null
      UnsupportedException - obstacleQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.