Interface ObstacleEnablerSmartMapSession

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

This session manages queries and sequencing to create "smart" dynamic maps. An ObstacleEnablerQuery can be retrieved from this session and mapped to this Map to create a virtual collection of obstacle enablers. The obstacle enabler may be sequenced using the ObstacleEnablerSearchOrder from this session.

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

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

    • getObstacleEnablerQuery

      ObstacleEnablerQuery getObstacleEnablerQuery()
      Gets an obstacle enabler query.
      Returns:
      the obstacle enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getObstacleEnablerSearchOrder

      ObstacleEnablerSearchOrder getObstacleEnablerSearchOrder()
      Gets an obstacle enabler search order.
      Returns:
      the obstacle enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyObstacleEnablerQuery

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

    • inspectObstacleEnablerQuery

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

    • applyObstacleEnablerSequencing

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

    • getObstacleEnablerQueryFromInspector

      ObstacleEnablerQuery getObstacleEnablerQueryFromInspector(ObstacleEnablerQueryInspector obstacleEnablerQueryInspector)
      Gets an obstacle enabler query from an inspector.
      Parameters:
      obstacleEnablerQueryInspector - an obstacle enabler query inspector
      Returns:
      the obstacle enabler query
      Throws:
      NullArgumentException - obstacleEnablerQueryInspector is null
      UnsupportedException - obstacleEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.