Interface CanonicalUnitProcessorNotificationSession

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

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

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

    • canRegisterForCanonicalUnitProcessorNotifications

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

    • reliableCanonicalUnitProcessorNotifications

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

    • unreliableCanonicalUnitProcessorNotifications

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

    • acknowledgeCanonicalUnitProcessorNotification

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

    • registerForNewCanonicalUnitProcessors

      void registerForNewCanonicalUnitProcessors() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new canonical unit processors. CanonicalUnitProcessorReceiver.newCanonicalUnitProcessors() is invoked when a new CanonicalUnitProcessor appears in this catalogue.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCanonicalUnitProcessors

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

    • registerForChangedCanonicalUnitProcessor

      void registerForChangedCanonicalUnitProcessor(Id canonicalUnitProcessorId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated canonical unit processor. ProvisionableReceiver.changedCanonicalUnitProcessors() is invoked when the specified canonical unit processor in this catalogue is changed.
      Parameters:
      canonicalUnitProcessorId - the Id of the CanonicalUnitProcessor to monitor
      Throws:
      NullArgumentException - canonicalUnitProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCanonicalUnitProcessors

      void registerForDeletedCanonicalUnitProcessors() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted canonical unit processors. CanonicalUnitProcessorReceiver.deletedCanonicalUnitProcessors() is invoked when a canonical unit processor is deleted or removed from this catalogue.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCanonicalUnitProcessor

      void registerForDeletedCanonicalUnitProcessor(Id canonicalUnitProcessorId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted canonical unit processor. CanonicalUnitProcessorReceiver.deletedCanonicalUnitProcessors() is invoked when the specified canonical unit processor is deleted or removed from this catalogue.
      Parameters:
      canonicalUnitProcessorId - the Id of the CanonicalUnitProcessor to monitor
      Throws:
      NullArgumentException - canonicalUnitProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.