Interface SpeedZoneEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to SpeedZoneEnabler objects in this Map . This also includes existing SpeedZoneEnablers 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 SpeedZoneEnablerLookupSession .

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

    • canRegisterForSpeedZoneEnablerNotifications

      boolean canRegisterForSpeedZoneEnablerNotifications()
      Tests if this user can register for SpeedZoneEnabler 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 enablers 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.

    • reliableSpeedZoneEnablerNotifications

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

    • unreliableSpeedZoneEnablerNotifications

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

    • acknowledgeSpeedZoneEnablerNotification

      void acknowledgeSpeedZoneEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a speed zone 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.

    • registerForNewSpeedZoneEnablers

      void registerForNewSpeedZoneEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new speed zone enablers. SpeedZoneEnablerReceiver.newSpeedZoneEnablers() is invoked when a new SpeedZoneEnabler appears in this map.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSpeedZoneEnablers

      void registerForChangedSpeedZoneEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated map enabelrs. SpeedZoneEnablerReceiver.changedSpeedZoneEnablers() is invoked when a speed zone enabler in this map is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSpeedZoneEnabler

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

    • registerForDeletedSpeedZoneEnablers

      void registerForDeletedSpeedZoneEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted speed zone enablers. SpeedZoneEnablerReceiver.deletedSpeedZoneEnablers() is invoked when a speed zone enabler is deleted or removed from this map.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSpeedZoneEnabler

      void registerForDeletedSpeedZoneEnabler(Id speedZoneEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted speed zone enabler. SpeedZoneEnablerReceiver.deletedSpeedZoneEnablers() is invoked when the specified speed zone enabler is deleted or removed from this map.
      Parameters:
      speedZoneEnablerId - the Id of the SpeedZoneEnabler to monitor
      Throws:
      NotFoundException - a speed zone enabler was not found in this speed zone matchmaker identified by the given Id
      NullArgumentException - speedZoneEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.