Interface ProgramNotificationSession

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

This session defines methods to receive notifications on adds/changes to Programs in this CourseCatalog . This also includes existing courses that may appear or disappear due to changes in the CourseCatalog 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 ProgramLookupSession .

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

    • canRegisterForProgramNotifications

      boolean canRegisterForProgramNotifications()
      Tests if this user can register for Program 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 programs in catalogs which are children of this 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 notifications to this course catalog only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableProgramNotifications

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

    • unreliableProgramNotifications

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

    • acknowledgeProgramNotification

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

    • registerForNewPrograms

      void registerForNewPrograms() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new programs. ProgramReceiver.newPrograms() is invoked when a new Program appears in this course catalog.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedPrograms

      void registerForChangedPrograms() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated programs. ProgramReceiver.changedPrograms() is invoked when a program in this course catalog is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProgram

      void registerForChangedProgram(Id programId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated program. ProgramReceiver.changedPrograms() is invoked when the specified program in this course catalog is changed.
      Parameters:
      programId - the Id of the program to monitor
      Throws:
      NullArgumentException - programId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedPrograms

      void registerForDeletedPrograms() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted programs. ProgramReceiver.deletedPrograms() is invoked when a program is deleted or removed from this course catalog.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProgram

      void registerForDeletedProgram(Id programId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted course. ProgramReceiver.deletedPrograms() is invoked when the specified program is deleted or removed from this course catalog.
      Parameters:
      programId - the Id of the program to monitor
      Throws:
      NullArgumentException - programId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.