Interface AwardEntryNotificationSession

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

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

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

    • canRegisterForAwardEntryNotifications

      boolean canRegisterForAwardEntryNotifications()
      Tests if this user can register for AwardEntry 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 award entries 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.

    • reliableAwardEntryNotifications

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

    • unreliableAwardEntryNotifications

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

    • acknowledgeAwardEntryNotification

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

    • registerForNewAwardEntries

      void registerForNewAwardEntries() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new award entries. AwardEntryReceiver.newAwardEntries() is invoked when a new AwardEntry appears in this course catalog.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewAwardEntriesForStudent

      void registerForNewAwardEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of new award entries for the given student. AwardEntryReceiver.newAwardEntries() is invoked when a new award entry 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.

    • registerForNewAwardEntriesForAward

      void registerForNewAwardEntriesForAward(Id awardId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of new award entries for the given award. AwardEntryReceiver.newAwardEntries() is invoked when a new award entry appears in this course catalog.
      Parameters:
      awardId - the Id of the Award to monitor
      Throws:
      NullArgumentException - awardId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAwardEntries

      void registerForChangedAwardEntries() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated award entries. AwardEntryReceiver.changedAwardEntries() is invoked when an award entry in this course catalog is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAwardEntriesForStudent

      void registerForChangedAwardEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated award entries for the given student. AwardEntryReceiver.changedAwardEntries() is invoked when an award entry is changed 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.

    • registerForChangedAwardEntriesForAward

      void registerForChangedAwardEntriesForAward(Id awardId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated award entries for the given award. AwardEntryReceiver.changedAwardEntries() is invoked when an award entry is changed in this course catalog.
      Parameters:
      awardId - the Id of the Award to monitor
      Throws:
      NullArgumentException - awardId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAwardEntry

      void registerForChangedAwardEntry(Id awardEntryId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated award entry. AwardEntryReceiver.changedAwardEntries() is invoked when the specified award entry in this course catalog is changed.
      Parameters:
      awardEntryId - the Id of the AwardEntry to monitor
      Throws:
      NullArgumentException - awardEntryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAwardEntries

      void registerForDeletedAwardEntries() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted award entries. AwardEntryReceiver.deletedAwardEntries() is invoked when an award entry is deleted or removed from this course catalog.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAwardEntriesForStudent

      void registerForDeletedAwardEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted award entries for the given student. AwardEntryReceiver.changedAwardEntries() is invoked when an award entry 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.

    • registerForDeletedAwardEntriesForAward

      void registerForDeletedAwardEntriesForAward(Id awardId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted award entries for the given award. AwardEntryReceiver.changedAwardEntries() is invoked when an award entry is deleted or removed from this course catalog.
      Parameters:
      awardId - the Id of the Award to monitor
      Throws:
      NullArgumentException - awardId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAwardEntry

      void registerForDeletedAwardEntry(Id awardEntryId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted award entry. AwardEntryReceiver.deletedAwardEntries() is invoked when the specified award entry is deleted or removed from this course catalog.
      Parameters:
      awardEntryId - the Id of the AwardEntry to monitor
      Throws:
      NullArgumentException - awardEntryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.