Interface DemographicEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to DemographicEnablers in this Bin . This also includes existing DemographicEnablers 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 DemographicEnablerLookupSession .

  • 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.

    • canRegisterForDemographicEnablerNotifications

      boolean canRegisterForDemographicEnablerNotifications()
      Tests if this user can register for DemographicEnabler 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 enablers 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.

    • reliableDemographicEnablerNotifications

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

    • unreliableDemographicEnablerNotifications

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

    • acknowledgeDemographicEnablerNotification

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

    • registerForNewDemographicEnablers

      void registerForNewDemographicEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new demographic enablers. DemographicEnablerReceiver.newDemographicEnablers() is invoked when a new DemographicEnabler appears in this bin.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedDemographicEnablers

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

    • registerForChangedDemographicEnabler

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

    • registerForDeletedDemographicEnablers

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

    • registerForDeletedDemographicEnabler

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