Interface ObstacleEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to ObstacleEnabler objects in this Map . This also includes existing ObstacleEnablers that may appear or disappear due to changes in the Map 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 ObstacleEnablerLookupSession .

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

    • canRegisterForObstacleEnablerNotifications

      boolean canRegisterForObstacleEnablerNotifications()
      Tests if this user can register for ObstacleEnabler 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 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.

    • reliableObstacleEnablerNotifications

      void reliableObstacleEnablerNotifications()
      Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeObstacleEnablerNotification() .
      Compliance:
      mandatory - This method is must be implemented.

    • unreliableObstacleEnablerNotifications

      void unreliableObstacleEnablerNotifications()
      Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
      Compliance:
      mandatory - This method is must be implemented.

    • acknowledgeObstacleEnablerNotification

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

    • registerForNewObstacleEnablers

      void registerForNewObstacleEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new obstacle enablers. ObstacleEnablerReceiver.newObstacleEnablers() is invoked when a new ObstacleEnabler appears in this map.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedObstacleEnablers

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

    • registerForChangedObstacleEnabler

      void registerForChangedObstacleEnabler(Id obstacleEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of an updated obstacle enabler. ProvisionableReceiver.changedObstacleEnablers() is invoked when the specified obstacle enabler in this map is changed.
      Parameters:
      obstacleEnablerId - the Id of the ObstacleEnabler to monitor
      Throws:
      NotFoundException - an obstacle enabler was not found in this broker matchmaker identified by the given Id
      NullArgumentException - obstacleEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedObstacleEnablers

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

    • registerForDeletedObstacleEnabler

      void registerForDeletedObstacleEnabler(Id obstacleEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted obstacle enabler. ObstacleEnablerReceiver.deletedObstacleEnablers() is invoked when the specified obstacle enabler is deleted or removed from this map.
      Parameters:
      obstacleEnablerId - the Id of the ObstacleEnabler to monitor
      Throws:
      NotFoundException - an obstacle enabler was not found in this broker matchmaker identified by the given Id
      NullArgumentException - obstacleEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.