Interface OfferingConstrainerEnablerNotificationSession

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

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

  • Method Details

    • getCatalogueId

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

    • getCatalogue

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

    • canRegisterForOfferingConstrainerEnablerNotifications

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

    • useFederatedCatalogueView

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

    • useIsolatedCatalogueView

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

    • reliableOfferingConstrainerEnablerNotifications

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

    • unreliableOfferingConstrainerEnablerNotifications

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

    • acknowledgeOfferingConstrainerEnablerNotification

      void acknowledgeOfferingConstrainerEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge an offering constrainer 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.

    • registerForNewOfferingConstrainerEnablers

      void registerForNewOfferingConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new offering constrainer enablers. OfferingConstrainerEnablerReceiver.newOfferingConstrainerEnablers() is invoked when a new OfferingConstrainerEnabler appears in this catalogue.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedOfferingConstrainerEnablers

      void registerForChangedOfferingConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated offering constrainer enablers. OfferingConstrainerEnablerReceiver.changedOfferingConstrainerEnablers() is invoked when an offering constrainer enabler in this catalogue is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedOfferingConstrainerEnabler

      void registerForChangedOfferingConstrainerEnabler(Id offeringConstrainerEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated offering constrainer enabler. ProvisionableReceiver.changedOfferingConstrainerEnablers() is invoked when the specified offering constrainer enabler in this catalogue is changed.
      Parameters:
      offeringConstrainerEnablerId - the Id of the OfferingConstrainerEnabler to monitor
      Throws:
      NullArgumentException - offeringConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedOfferingConstrainerEnablers

      void registerForDeletedOfferingConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted offering constrainer enablers. OfferingConstrainerEnablerReceiver.deletedOfferingConstrainerEnablers() is invoked when an offering constrainer enabler is deleted or removed from this catalogue.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedOfferingConstrainerEnabler

      void registerForDeletedOfferingConstrainerEnabler(Id offeringConstrainerEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted offering constrainer enabler. OfferingConstrainerEnablerReceiver.deletedOfferingConstrainerEnablers() is invoked when the specified offering constrainer enabler is deleted or removed from this catalogue.
      Parameters:
      offeringConstrainerEnablerId - the Id of the OfferingConstrainerEnabler to monitor
      Throws:
      NullArgumentException - offeringConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.