Interface CanonicalUnitProcessorEnablerNotificationSession

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

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

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

    • canRegisterForCanonicalUnitProcessorEnablerNotifications

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

    • reliableCanonicalUnitProcessorEnablerNotifications

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

    • unreliableCanonicalUnitProcessorEnablerNotifications

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

    • acknowledgeCanonicalUnitProcessorEnablerNotification

      void acknowledgeCanonicalUnitProcessorEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a caninical unit processor 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.

    • registerForNewCanonicalUnitProcessorEnablers

      void registerForNewCanonicalUnitProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new canonical unit processor enablers. CanonicalUnitProcessorEnablerReceiver.newCanonicalUnitProcessorEnablers() is invoked when a new CanonicalUnitProcessorEnabler appears in this catalogue.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCanonicalUnitProcessorEnablers

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

    • registerForChangedCanonicalUnitProcessorEnabler

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

    • registerForDeletedCanonicalUnitProcessorEnablers

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

    • registerForDeletedCanonicalUnitProcessorEnabler

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