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 in this Business . This also includes existing posts that may appear or disappear due to changes in the Business 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 PostLookupSession .

  • Method Details

    • getBusinessId

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

    • getBusiness

      Business getBusiness() throws OperationFailedException, PermissionDeniedException
      Gets the Business associated with this session.
      Returns:
      the business
      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.

    • useFederatedBusinessView

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

    • useIsolatedBusinessView

      void useIsolatedBusinessView()
      Isolates the view for methods in this session. An isolated view restricts notifications to this business 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 appears in this business.
      Throws:
      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 payers. PostReceiver.changedPosts() is invoked when a payer in this business is changed.
      Throws:
      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 in this business 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 payers. PostReceiver.deletedPosts() is invoked when a post is deleted or removed from this business.
      Throws:
      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 or removed from this business.
      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.