Interface ResourceVelocityNotificationSession

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

This session defines methods to receive notifications on adds/changes to resource velocities in this Map . 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.

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

    • canRegisterForResourcePathNotifications

      boolean canRegisterForResourcePathNotifications()
      Tests if this user can register for 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 wish not to offer notification operations to unauthorized users.
      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 locations 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.

    • registerForMovingResources

      void registerForMovingResources() throws OperationFailedException, PermissionDeniedException
      Registers for notification of moved resources. ResourceVelocityReceiver.movingResource() is invoked when a resource begins to move.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForMovingResource

      void registerForMovingResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of moved resources. ResourceVelocityReceiver.movingResource() is invoked when the specified resource begins to move.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForMovingResourcesByGenusType

      void registerForMovingResourcesByGenusType(Type resourceGenusType) throws OperationFailedException, PermissionDeniedException
      Registers for notification of moved resources for the given resource genus type. ResourceVelocityReceiver.movingResource() is invoked when a resource begins to move.
      Parameters:
      resourceGenusType - the genus type of the Resource to monitor
      Throws:
      NullArgumentException - resourceGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForStoppedResources

      void registerForStoppedResources() throws OperationFailedException, PermissionDeniedException
      Registers for notification of stopped resources. ResourceVelocityReceiver.stoppedResource() is invoked when a resource stops moving.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForStoppedResource

      void registerForStoppedResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of stopped resources. ResourceVelocityReceiver.stoppedResource() is invoked when the specified resource stops moving.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForStoppedResourcesByGenusType

      void registerForStoppedResourcesByGenusType(Type resourceGenusType) throws OperationFailedException, PermissionDeniedException
      Registers for notification of stopped resources for the given resource genus type. ResourceVelocityReceiver.stoppedResource() is invoked when a resource stops moving.
      Parameters:
      resourceGenusType - the genus type of the Resource to monitor
      Throws:
      NullArgumentException - resourceGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedResourceVelocities

      void registerForChangedResourceVelocities() throws OperationFailedException, PermissionDeniedException
      Registers for notification of changed resource velocities. ResourceRouteReceiver.changedResourceVelcoity() is invoked when a resource changes speed or direction.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerFoChangedResourceVelocity

      void registerFoChangedResourceVelocity(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of moving resources. ResourceRouteReceiver.changedResourceVelocityResource() is invoked when the specified resource changes speed or direction.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedResourceVelocitiesByGenusType

      void registerForChangedResourceVelocitiesByGenusType(Type resourceGenusType) throws OperationFailedException, PermissionDeniedException
      Registers for notification of moving resources for the given resource genus type. ResourceRouteReceiver.changedResourceVelocity() is invoked when a resource changes speed or direction.
      Parameters:
      resourceGenusType - the genus type of the Resource to monitor
      Throws:
      NullArgumentException - resourceGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.