Interface PostNotificationSession

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

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

Notifications are triggered with changes to the Post object itself. Adding and removing replies result in notifications available from the notification session for replies.

  • Method Details

    • getForumId

      Id getForumId()
      Gets the Forum Id associated with this session.
      Returns:
      the Forum Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getForum

      Forum getForum() throws OperationFailedException, PermissionDeniedException
      Gets the Forum associated with this session.
      Returns:
      the forum
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForPostNotifications

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

    • useFederatedForumView

      void useFederatedForumView()
      Federates the view for methods in this session. A federated view will include posts in forums which are children of this forum in the forum hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedForumView

      void useIsolatedForumView()
      Isolates the view for methods in this session. An isolated view restricts notifications to this forum only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliablePostNotifications

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

    • unreliablePostNotifications

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

    • acknowledgePostNotification

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

    • registerForNewPosts

      void registerForNewPosts() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new posts. PostReceiver.newPosts() is invoked when a new Post is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewPostsForPoster

      void registerForNewPostsForPoster(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new posts for the given poster resource Id . PostReceiver.newPosts() is invoked when a new Post is created.
      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.

    • registerForChangedPosts

      void registerForChangedPosts() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated posts. PostReceiver.changedPosts() is invoked when a post is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedPostsForPoster

      void registerForChangedPostsForPoster(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of changed posts for the given poster resource Id . PostReceiver.changedPosts() is invoked when a Post for the given agent is updated.
      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.

    • registerForChangedPost

      void registerForChangedPost(Id postId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated post. PostReceiver.changedPosts() is invoked when the specified post is changed.
      Parameters:
      postId - the Id of the Post to monitor
      Throws:
      NullArgumentException - postId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedPosts

      void registerForDeletedPosts() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted posts. PostReceiver.deletedPosts() is invoked when a post is deleted.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedPostsForPoster

      void registerForDeletedPostsForPoster(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted posts for the given poster resource Id . PostReceiver.deletedPosts() is invoked when a Post for the given agent is removed.
      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.

    • registerForDeletedPost

      void registerForDeletedPost(Id postId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted post. PostReceiver.deletedPosts() is invoked when the specified post is deleted.
      Parameters:
      postId - the Id of the Post to monitor
      Throws:
      NullArgumentException - postId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.