Interface CourseRegistrationNotificationSession

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

This session defines methods to receive notifications on adds/changes to CourseRegistra tions in this CourseCatalog . This also includes existing course registrations 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 CourseRegistrationLookupSessi on.

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

    • canRegisterForCourseRegistrationNotifications

      boolean canRegisterForCourseRegistrationNotifications()
      Tests if this user can register for CourseRegistr ation 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 course registrations 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 notifications to this course catalog only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableCourseRegistrationNotifications

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

    • unreliableCourseRegistrationNotifications

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

    • acknowledgeCourseRegistrationNotification

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

    • registerForNewCourseRegistrations

      void registerForNewCourseRegistrations() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new course registrations. CourseRegistrationReceiver.newCourseRegistrations() is invoked when a new CourseRegistration appears in this course catalog.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewCourseRegistrationsForRegistration

      void registerForNewCourseRegistrationsForRegistration(Id registrationId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new course registrations for the given registration. CourseRegistrationReceiver.newCourseRegistrations() is invoked when a new CourseRegistration appears in this course catalog.
      Parameters:
      registrationId - the Id of the Registration to monitor
      Throws:
      NullArgumentException - registrationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewCourseRegistrationsForCourseOffering

      void registerForNewCourseRegistrationsForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new course registrations for the given course offering. CourseRegistrationReceiver.newCourseRegistrations() is invoked when a new CourseRegistration appears in this course catalog.
      Parameters:
      courseOfferingId - the Id of the CourseOffering to monitor
      Throws:
      NullArgumentException - courseOfferingId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewCourseRegistrationsForStudent

      void registerForNewCourseRegistrationsForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new course registrations for the given student. CourseRegistrationReceiver.newCourseRegistrations() is invoked when a new CourseRegistration appears in this course catalog.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCourseRegistrations

      void registerForChangedCourseRegistrations() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated course registrations. CourseRegistrationReceiver.changedCourseRegistrations() is invoked when a CourseRegistration in this course catalog is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCourseRegistrationsForRegistration

      void registerForChangedCourseRegistrationsForRegistration(Id registrationId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated course registrations for the given registration. CourseRegistrationReceiver.changedCourseRegistrations() is invoked when a CourseRegistration in this course catalog is changed.
      Parameters:
      registrationId - the Id of the Registration to monitor
      Throws:
      NullArgumentException - registrationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCourseRegistrationsForCourseOffering

      void registerForChangedCourseRegistrationsForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated course registrations for the given course offering. CourseRegistrationReceiver.changedCourseRegistrations() is invoked when a CourseRegistration in this course catalog is changed.
      Parameters:
      courseOfferingId - the Id of the CourseOffering to monitor
      Throws:
      NullArgumentException - courseOfferingId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCourseRegistrationsForStudent

      void registerForChangedCourseRegistrationsForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated course registrations for the given student. CourseRegistrationReceiver.changedCourseRegistrations() is invoked when a CourseRegistration in this course catalog is changed.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCourseRegistration

      void registerForChangedCourseRegistration(Id courseRegistrationId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated course registration. CourseRegistrationReceiver.changedCourseRegistrations() is invoked when the specified CourseRegistration in this course catalog is changed.
      Parameters:
      courseRegistrationId - the Id of the CourseRegistration to monitor
      Throws:
      NullArgumentException - courseRegistrationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCourseRegistrations

      void registerForDeletedCourseRegistrations() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted course registrations. CourseRegistrationReceiver.deletedCourseRegistrations() is invoked when a course registration is deleted or removed from this course catalog.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCourseRegistrationsForRegistration

      void registerForDeletedCourseRegistrationsForRegistration(Id registrationId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted course registrations for thegiven registration. CourseRegistrationReceiver.deletedCourseRegistrations() is invoked when a course registration is deleted or removed from this course catalog.
      Parameters:
      registrationId - the Id of the Registration to monitor
      Throws:
      NullArgumentException - registrationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCourseRegistrationsForCourseOffering

      void registerForDeletedCourseRegistrationsForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted course registrations for the given course offering. CourseRegistrationReceiver.deletedCourseRegistrations() is invoked when a course registration is deleted or removed from this course catalog.
      Parameters:
      courseOfferingId - the Id of the CourseOffering to monitor
      Throws:
      NullArgumentException - courseOfferingId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCourseRegistrationsForStudent

      void registerForDeletedCourseRegistrationsForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted course registrations for the given student. CourseRegistrationReceiver.deletedCourseRegistrations() is invoked when a course registration is deleted or removed from this course catalog.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCourseRegistration

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