Interface TermNotificationSession

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

This session defines methods to receive notifications on adds/changes to Terms . in this CourseCatalog . This also includes existing terms 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 TermLookupSession .

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

    • canRegisterForTermNotifications

      boolean canRegisterForTermNotifications()
      Tests if this user can register for Term 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 terms 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.

    • reliableTermNotifications

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

    • unreliableTermNotifications

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

    • acknowledgeTermNotification

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

    • registerForNewTerms

      void registerForNewTerms() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new terms. TermReceiver.newTerms() is invoked when a new Term appears in this course catalog.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedTerms

      void registerForChangedTerms() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated courses. TermReceiver.changedTerms() is invoked when a term in this course catalog is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedTerm

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

    • registerForDeletedTerms

      void registerForDeletedTerms() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted terms. TermReceiver.deletedTerms() is invoked when a term is deleted or removed from this course catalog.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedTerm

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

    • registerForChangedTermHierarchy

      void registerForChangedTermHierarchy() throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated term hierarchy structure. TermReceiver.changedChildOTerms() is invoked when a node experiences a change in its children.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedTermHierarchyForAncestors

      void registerForChangedTermHierarchyForAncestors(Id termId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated term hierarchy structure. TermReceiver.changedChildOfTerms() is invoked when the specified node or any of its ancestors experiences a change in its children.
      Parameters:
      termId - the Id of the Term node to monitor
      Throws:
      NullArgumentException - termId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedTermHierarchyForDescendants

      void registerForChangedTermHierarchyForDescendants(Id termId) throws OperationFailedException, PermissionDeniedException
      Term Receiver.changedChildOfTerms() is invoked when the specified node or any of its descendants experiences a change in its children.
      Parameters:
      termId - the Id of the Term node to monitor
      Throws:
      NullArgumentException - termId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.