Interface CanonicalUnitNotificationSession

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

This session defines methods to receive notifications on adds/changes to CanonicalUnits . 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.

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

    • canRegisterForCanonicalUnitNotifications

      boolean canRegisterForCanonicalUnitNotifications()
      Tests if this user can register for CanonicalUnit 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 notifications for canonical unitss 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.

    • reliableCanonicalUnitNotifications

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

    • unreliableCanonicalUnitNotifications

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

    • acknowledgeCanonicalUnitNotification

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

    • registerForNewCanonicalUnits

      void registerForNewCanonicalUnits() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new canonical units. CanonicalUnitReceiver.newCanonicalUnits() is invoked when a new CanonicalUnit is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCanonicalUnits

      void registerForChangedCanonicalUnits() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated canonical units. CanonicalUnitReceiver.changedCanonicalUnits() is invoked when a canonical unit in this catalogue is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCanonicalUnit

      void registerForChangedCanonicalUnit(Id canonicalUnitId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of an updated canonical unit. CanonicalUnitReceiver.changedCanonicalUnits() is invoked when the specified canonical unit in this catalogue is changed.
      Parameters:
      canonicalUnitId - the Id of the CanonicalUnit to monitor
      Throws:
      NotFoundException - a canonical unit was not found identified by the given Id
      NullArgumentException - canonicalUnitId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCanonicalUnits

      void registerForDeletedCanonicalUnits() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted canonical units. CanonicalUnitReceiver.deletedCanonicalUnits() is invoked when a canonical unit is removed from this catalogue.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCanonicalUnit

      void registerForDeletedCanonicalUnit(Id canonicalUnitId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted canonical unit. CanonicalUnitReceiver.deletedCanonicalUnits() is invoked when the specified canonical unit is removed from this catalogue.
      Parameters:
      canonicalUnitId - the Id of the CanonicalUnit to monitor
      Throws:
      NotFoundException - a canonical unit was not found identified by the given Id
      NullArgumentException - canonicalUnitId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.