Interface OfferingConstrainerNotificationSession

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

This session defines methods to receive notifications on adds/changes to OfferingConstrainer objects in this Catalogue . This also includes existing OfferingConstrainers 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 OfferingConstrainerLookupSession .

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

    • canRegisterForOfferingConstrainerNotifications

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

    • reliableOfferingConstrainerNotifications

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

    • unreliableOfferingConstrainerNotifications

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

    • acknowledgeOfferingConstrainerNotification

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

    • registerForNewOfferingConstrainers

      void registerForNewOfferingConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new offering constrainers. OfferingConstrainerReceiver.newOfferingConstrainers() is invoked when a new OfferingConstrainer appears in this catalogue.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedOfferingConstrainers

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

    • registerForChangedOfferingConstrainer

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

    • registerForDeletedOfferingConstrainers

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

    • registerForDeletedOfferingConstrainer

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