Interface DemographicNotificationSession

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

This session defines methods to receive notifications on adds/changes to Demographics in this Bin . This also includes existing Demographics that may appear or disappear due to changes in the Bin 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 DemographicLookupSession .

  • Method Details

    • getBinId

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

    • getBin

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

    • canRegisterForDemographicNotifications

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

    • useFederatedBinView

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

    • useIsolatedBinView

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

    • reliableDemographicNotifications

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

    • unreliableDemographicNotifications

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

    • acknowledgeDemographicNotification

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

    • registerForNewDemographics

      void registerForNewDemographics() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new demographics. DemographicReceiver.newDemographics() is invoked when a new Demographic appears in this bin.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedDemographics

      void registerForChangedDemographics() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated demographics. DemographicReceiver.changedDemographics() is invoked when a demographic in this bin is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedDemographic

      void registerForChangedDemographic(Id demographicId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated demographic. ProvisionableReceiver.changedDemographics() is invoked when the specified demographic in this bin is changed.
      Parameters:
      demographicId - the Id of the Demographic to monitor
      Throws:
      NullArgumentException - demographicId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedDemographics

      void registerForDeletedDemographics() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted demographics. DemographicReceiver.deletedDemographics() is invoked when a demographic is deleted or removed from this bin.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedDemographic

      void registerForDeletedDemographic(Id demographicId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted demographic. DemographicReceiver.deletedDemographics() is invoked when the specified demographic is deleted or removed from this bin.
      Parameters:
      demographicId - the Id of the Demographic to monitor
      Throws:
      NullArgumentException - demographicId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.