Interface ResourcePathNotificationSession

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

This session defines methods to receive notifications on adds/changes to resources on paths 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 paths 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.

    • registerForEnteredPaths

      void registerForEnteredPaths() throws OperationFailedException, PermissionDeniedException
      Register for notifications of resource starting on paths. ResourcePathReceiver.enteredPath() is invoked when a resource turns on to a path.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForEnteredPath

      void registerForEnteredPath(Id pathId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of resources starting on paths. ResourcePathReceiver.enteredPath() is invoked when a resource turns on to the specified path.
      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.

    • registerForEnteredPathsForResource

      void registerForEnteredPathsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of a started path. ResourcePathReceiver.enteredPath() is invoked when the specified resource begins a path.
      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.

    • registerForEnteredPathsForResourcesByGenusType

      void registerForEnteredPathsForResourcesByGenusType(Type resourceGenusType) throws OperationFailedException, PermissionDeniedException
      Register for notifications of a started path for resources of the given genus type. ResourcePathReceiver.enteredPath() is invoked when the specified resource begins a path.
      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.

    • registerForExitedPaths

      void registerForExitedPaths() throws OperationFailedException, PermissionDeniedException
      Register for notifications of resource exits paths. ResourcePathReceiver.exitedPath() is invoked when a resource turns leaves a path.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForExitedPath

      void registerForExitedPath(Id pathId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of resources exits paths. ResourcePathReceiver.exitedPath() is invoked when a resource leaves the specified path.
      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.

    • registerForExitedPathsForResource

      void registerForExitedPathsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an exited path. ResourcePathReceiver.exitedPath() is invoked when the specified resource leaves a path.
      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.

    • registerForExitedPathsForResourcesByGenusType

      void registerForExitedPathsForResourcesByGenusType(Type resourceGenusType) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an exited path for resources of the given genus type. ResourcePathReceiver.exitedPath() is invoked when the specified resource leaves a path.
      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.