Interface ObstacleNotificationSession

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

This session defines methods to receive notifications on adds/changes to Obstacle objects in this Map . This also includes existing obstacle that may appear or disappear due to changes in the Obstacle hierarchy, This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

The two views defined in this session correspond to the views in the ObstacleLookupSession .

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

    • canRegisterForObstacleNotifications

      boolean canRegisterForObstacleNotifications()
      Tests if this user can register for Obstacle notifications. 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 opt not to offer notification operations.
      Returns:
      false if notification methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedMapView

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

    • useIsolatedMapView

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

    • acknowledgeObstacleNotification

      void acknowledgeObstacleNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a obstacle notification.
      Parameters:
      notificationId - the Id of the notification
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewObstacles

      void registerForNewObstacles() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new obstacles. ObstacleReceiver.newObstacles() is invoked when a new Obstacle appears in this map.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewObstaclesForPath

      void registerForNewObstaclesForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new obstacles. for the given path. ObstacleReceiver.newObstacles() is invoked when a new Obstacle appears in this map.
      Parameters:
      pathId - the Id of the path to monitor
      Throws:
      NullArgumentException - pathId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedObstacles

      void registerForChangedObstacles() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated obstacles. ObstacleReceiver.changedObstacles() is invoked when an obstacle in this map is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedObstacle

      void registerForChangedObstacle(Id obstacleId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated obstacle. ObstacleReceiver.changedObstacles() is invoked when the specified obstacle in this map is changed.
      Parameters:
      obstacleId - the Id of the Obstacle to monitor
      Throws:
      NullArgumentException - obstacleId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedObstaclesForPath

      void registerForChangedObstaclesForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated obstacles along the given path. ObstacleReceiver.changedObstacles() is invoked when an obstacle in this map is changed.
      Parameters:
      pathId - the Id of the Path to monitor
      Throws:
      NullArgumentException - pathId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedObstacles

      void registerForDeletedObstacles() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted obstacles. ObstacleReceiver.deletedObstacles() is invoked when an obstacle is deleted or removed from this map.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedObstacle

      void registerForDeletedObstacle(Id obstacleId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted obstacle. ObstacleReceiver.deletedObstacles() is invoked when the specified obstacle is deleted or removed from this map.
      Parameters:
      obstacleId - the Id of the Obstacle to monitor
      Throws:
      NullArgumentException - obstacleId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedObstaclesForPath

      void registerForDeletedObstaclesForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted obstacleq for the given path. ObstacleReceiver.deletedObstacles() is invoked when an obstacle is deleted or removed from this map.
      Parameters:
      pathId - the Id of the path to monitor
      Throws:
      NullArgumentException - pathId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.