Interface SyllabusNotificationSession

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

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

    • canRegisterForSyllabusNotifications

      boolean canRegisterForSyllabusNotifications()
      Tests if this user can register for Syllabus 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 syllabi 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.

    • reliableSyllabusNotifications

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

    • unreliableSyllabusNotifications

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

    • acknowledgeSyllabusNotification

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

    • registerForNewSyllabi

      void registerForNewSyllabi() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new syllabi. SyllabusReceiver.newSyllabi() is invoked when a new Syllabus is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewSyllabiForCourse

      void registerForNewSyllabiForCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new syllabi for the given course. SyllabusReceiver.newSyllabi() is invoked when a new Syllabus is created.
      Parameters:
      courseId - the Id of the course to monitor
      Throws:
      NullArgumentException - courseId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSyllabi

      void registerForChangedSyllabi() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated syllabi. SyllabusReceiver.changedSyllabi() is invoked when a syllabus is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSyllabiForCourse

      void registerForChangedSyllabiForCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of changed syllabi for the given course Id . SyllabusReceiver.changedSyllabi() is invoked when a Syllabus for the coursein this catalog is changed.
      Parameters:
      courseId - the Id of the course to monitor
      Throws:
      NullArgumentException - courseId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSyllabus

      void registerForChangedSyllabus(Id syllabusId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated syllabus. SyllabusReceiver.changedSyllabi() is invoked when the specified syllabus 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.

    • registerForDeletedSyllabi

      void registerForDeletedSyllabi() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted syllabi. SyllabusReceiver.deletedSyllabi() is invoked when a syllabus is deleted.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSyllabiForCourse

      void registerForDeletedSyllabiForCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted syllabi for the given course Id . SyllabusReceiver.deletedSyllabi() is invoked when a Syllabus for the course in this catalog is deleted.
      Parameters:
      courseId - the Id of the course to monitor
      Throws:
      NullArgumentException - courseId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSyllabus

      void registerForDeletedSyllabus(Id syllabusId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted syllabus. SyllabusReceiver.deletedSyllabi() is invoked when the specified syllabus 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.