Interface GraphNotificationSession

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

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

    • canRegisterForGraphNotifications

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

    • reliableGraphNotifications

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

    • unreliableGraphNotifications

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

    • acknowledgeGraphNotification

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

    • registerForNewGraphs

      void registerForNewGraphs() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new graphs. GraphReceiver.newGraphs() is invoked when a new Graph is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedGraphs

      void registerForChangedGraphs() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated graphs. GraphReceiver.changedGraphs() is invoked when a graph is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedGraph

      void registerForChangedGraph(Id graphId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated graph. GraphReceiver.changedGraphs() is invoked when the specified graph is changed.
      Parameters:
      graphId - the Id of the Graph to monitor
      Throws:
      NullArgumentException - graphId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedGraphs

      void registerForDeletedGraphs() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted graphs. GraphReceiver.deletedGraphs() is invoked when a graph is deleted.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedGraph

      void registerForDeletedGraph(Id graphId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted graph. GraphReceiver.deletedGraphs() is invoked when the specified graph is deleted.
      Parameters:
      graphId - the Id of the Graph to monitor
      Throws:
      NullArgumentException - graphId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedGraphHierarchy

      void registerForChangedGraphHierarchy() throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated graph hierarchy structure. GraphReceiver.changedChildOfGraphs() is invoked when a node experiences a change in its children.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedGraphHierarchyForAncestors

      void registerForChangedGraphHierarchyForAncestors(Id graphId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated graph hierarchy structure. GraphReceiver.changedChildOfGraphs() is invoked when the specified node or any of its ancestors experiences a change in its children.
      Parameters:
      graphId - the Id of the Graph node to monitor
      Throws:
      NullArgumentException - graphId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedGraphHierarchyForDescendants

      void registerForChangedGraphHierarchyForDescendants(Id graphId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated graph hierarchy structure. GraphReceiver.changedChildOfGraphs() is invoked when the specified node or any of its descendants experiences a change in its children.
      Parameters:
      graphId - the Id of the Graph node to monitor
      Throws:
      NullArgumentException - graphId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.