Interface ModuleNotificationSession

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

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

    • getCourseCatalogId

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

    • getCourseCatalog

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

    • canRegisterForModuleNotifications

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

    • useFederatedCourseCatalogView

      void useFederatedCourseCatalogView()
      Federates the view for methods in this session. A federated view will include modules in course catalogs which are children of this course catalog in the course catalog hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCourseCatalogView

      void useIsolatedCourseCatalogView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableModuleNotifications

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

    • unreliableModuleNotifications

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

    • acknowledgeModuleNotification

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

    • registerForNewModules

      void registerForNewModules() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new modules. ModuleReceiver.newModules() is invoked when a new Module is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewModulesForSyllabus

      void registerForNewModulesForSyllabus(Id syllabusId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new modules for the given syllabus. ModuleReceiver.newModules() is invoked when a new Module is created.
      Parameters:
      syllabusId - the Id of the Syllabus to monitor
      Throws:
      NullArgumentException - syllabusId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedModules

      void registerForChangedModules() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated modules. ModuleReceiver.changedModules() is invoked when a module is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedModulesForSyllabus

      void registerForChangedModulesForSyllabus(Id syllabusId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated modules for the given syllabus. ModuleReceiver.changedModules() is invoked when a module is changed.
      Parameters:
      syllabusId - the Id of the Syllabus to monitor
      Throws:
      NullArgumentException - syllabusId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedModule

      void registerForChangedModule(Id moduleId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated module. ModuleReceiver.changedModules() is invoked when the specified module is changed.
      Parameters:
      moduleId - the Id of the Module to monitor
      Throws:
      NullArgumentException - moduleId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedModules

      void registerForDeletedModules() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted modules. ModuleReceiver.deletedModules() is invoked when a module in this catalog is deleted.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedModulesForSyllabus

      void registerForDeletedModulesForSyllabus(Id syllabusId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted modules for the given syllabus. ModuleReceiver.deletedModules() is invoked when a module in this catalog is deleted.
      Parameters:
      syllabusId - the Id of the Syllabus to monitor
      Throws:
      NullArgumentException - syllabusId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedModule

      void registerForDeletedModule(Id moduleId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted module. ModuleReceiver.deletedModules() is invoked when the specified module in this catalog is deleted.
      Parameters:
      moduleId - the Id of the Module to monitor
      Throws:
      NullArgumentException - moduleId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.