Interface AssessmentOfferedNotificationSession

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

This session defines methods to receive notifications on adds/changes to AssessmentOffered objects in this Bank . 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 AssessmentOfferedLookupSession .

  • Method Details

    • getBankId

      Id getBankId()
      Gets the Bank Id associated with this session.
      Returns:
      the Bank Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getBank

      Bank getBank() throws OperationFailedException, PermissionDeniedException
      Gets the Bank associated with this session.
      Returns:
      the Bank associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForAssessmentOfferedNotifications

      boolean canRegisterForAssessmentOfferedNotifications()
      Tests if this user can register for AssessmentOffered 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.

    • useFederatedBankView

      void useFederatedBankView()
      Federates the view for methods in this session. A federated view will include notifications for assessments offered in banks which are children of this bank in the bank hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedBankView

      void useIsolatedBankView()
      Isolates the view for methods in this session. An isolated view restricts notifications for assessments offered to this bank only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableAssessmentOfferedNotifications

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

    • unreliableAssessmentOfferedNotifications

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

    • acknowledgeAssessmentOfferedNotification

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

    • registerForNewAssessmentsOffered

      void registerForNewAssessmentsOffered() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new assessments offered. AssessmentOfferedReceiver.newAssessmentsOffered() is invoked when a new AssessmentOffered appears in this assessmen tbank.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewAssessmentsOfferedForAssessment

      void registerForNewAssessmentsOfferedForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new assessments offered by assessment. AssessmentOfferedReceiver.newAssessmentsOffered() is invoked when a new AssessmentOffered appears in this assessment bank.
      Parameters:
      assessmentId - Id of an assessment to monitor
      Throws:
      NullArgumentException - assessmentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAssessmentsOffered

      void registerForChangedAssessmentsOffered() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated assessments offered. AssessmentOfferedReceiver.changedAssessmentsOffered() is invoked when an assessment offered in this assessment bank is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAssessmentsOfferedForAssessment

      void registerForChangedAssessmentsOfferedForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated assessments offered by assessment. AssessmentOfferedReceiver.changedAssessmentsOffered() is invoked when an AssessmentOffered in this assessment bank is changed.
      Parameters:
      assessmentId - Id of an assessment to monitor
      Throws:
      NullArgumentException - assessmentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAssessmentOffered

      void registerForChangedAssessmentOffered(Id assessmentOfferedId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated assessment offered. AssessmentOfferedReceiver.changedAssessmentsOffered() is invoked when the specified assessment offered in this assessment bank is changed.
      Parameters:
      assessmentOfferedId - the Id of the AssessmentOffered to monitor
      Throws:
      NullArgumentException - assessmentOfferedId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAssessmentsOffered

      void registerForDeletedAssessmentsOffered() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted assessments offered. AssessmentOfferedReceiver.deletedAssessmentsOffered() is invoked when an assessment offered is removed from the assessment bank.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAssessmentsOfferedForAssessment

      void registerForDeletedAssessmentsOfferedForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted assessments offered by assessment. AssessmentOfferedReceiver.deletedAssessmenstOffered() is invoked when an AssessmentOffered is removed form the assessment bank.
      Parameters:
      assessmentId - Id of an assessment to monitor
      Throws:
      NullArgumentException - assessmentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAssessmentOffered

      void registerForDeletedAssessmentOffered(Id assessmentOfferedId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted assessment offered. AssessmentOfferedReceiver.deletedAssessmentsOffered() is invoked when the specified assessment offered is removed from the assessment bank.
      Parameters:
      assessmentOfferedId - the Id of the AssessmentOffered to monitor
      Throws:
      NullArgumentException - assessmentOfferedId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.