Interface AssessmentTakenNotificationSession

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

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

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

    • canRegisterForAssessmentTakenNotifications

      boolean canRegisterForAssessmentTakenNotifications()
      Tests if this user can register for AssessmentTaken 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 taken 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 taken to this bank only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableAssessmentTakenNotifications

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

    • unreliableAssessmentTakenNotifications

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

    • acknowledgeAssessmentTakenNotification

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

    • registerForNewAssessmentsTaken

      void registerForNewAssessmentsTaken() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new assessments taken in this assessment bank. AssessmentTakenReceiver.newAssessmentsTaken() is invoked when a new AssessmentTaken appears in this assessment bank.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewAssessmentsTakenForTaker

      void registerForNewAssessmentsTakenForTaker(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new assessments taken for a resource. AssessmentTakenReceiver.newAssessmenstTaken() is invoked when a new AssessmentTaken appears in this assessment bank.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - assessmentOfferedId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewAssessmentsTakenForAssessmentOffered

      void registerForNewAssessmentsTakenForAssessmentOffered(Id assessmentOfferedId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new assessments taken for an assessment offered. AssessmentTakenReceiver.newAssessmentsTaken() is invoked when a new AssessmentTaken appears in this 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.

    • registerForNewAssessmentsTakenForAssessment

      void registerForNewAssessmentsTakenForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new assessments taken for an assessment. AssessmentTakenReceiver.newAssessmentsTaken() is invoked when a new AssessmentTaken appears in this assessment bank.
      Parameters:
      assessmentId - the Id of the Assessment to monitor
      Throws:
      NullArgumentException - assessmentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAssessmentsTaken

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

    • registerForChangedAssessmentsTakenForTaker

      void registerForChangedAssessmentsTakenForTaker(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of changed assessments taken for a resource. AssessmentTakenReceiver.changedAssessmentsTaken() is invoked when an AssessmentTaken is changed in this assessment bank.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - assessmentOfferedId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAssessmentsTakenForAssessmentOffered

      void registerForChangedAssessmentsTakenForAssessmentOffered(Id assessmentOfferedId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of changed assessments taken for an assessment offered. AssessmentTakenReceiver.changedAssessmentsTaken() is invoked when an AssessmentTaken is changed in this 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.

    • registerForChangedAssessmentsTakenForAssessment

      void registerForChangedAssessmentsTakenForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of changed assessments taken for an assessment. AssessmentTakenReceiver.changedAssessmentsTaken() is invoked when an AssessmentTaken is changed in this assessment bank.
      Parameters:
      assessmentId - the Id of the Assessment to monitor
      Throws:
      NullArgumentException - assessmentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAssessmentTaken

      void registerForChangedAssessmentTaken(Id assessmentTakenId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated assessment taken. AssessmentTakenReceiver.changedAssessmentsTaken() is invoked when the specified assessment taken in this assessment bank is changed.
      Parameters:
      assessmentTakenId - the Id of the AssessmentTaken to monitor
      Throws:
      NullArgumentException - assessmentTakenId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAssessmentsTaken

      void registerForDeletedAssessmentsTaken() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted assessments taken. AssessmentTakenReceiver.deletedAssessmentsTaken() is invoked when an assessment taken is removed from this assessment bank.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAssessmentsTakenForTaker

      void registerForDeletedAssessmentsTakenForTaker(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted assessments taken for a resource. AssessmentTakenReceiver.deletedAssessmentsTaken() is invoked when an AssessmentTaken is removed from this assessment bank.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - assessmentOfferedId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAssessmentsTakenForAssessmentOffered

      void registerForDeletedAssessmentsTakenForAssessmentOffered(Id assessmentOfferedId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted assessments taken for an assessment offered. AssessmentTakenReceiver.deletedAssessmentsTaken() is invoked when an AssessmentTaken is removed from this 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.

    • registerForDeletedAssessmentsTakenForAssessment

      void registerForDeletedAssessmentsTakenForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted assessments taken for an assessment. AssessmentTakenReceiver.deletedAssessmentsTaken() is invoked when an AssessmentTaken is removed from this assessment bank.
      Parameters:
      assessmentId - the Id of the Assessment to monitor
      Throws:
      NullArgumentException - assessmentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAssessmentTaken

      void registerForDeletedAssessmentTaken(Id assessmentTakenId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted assessment taken. AssessmentTakenReceiver.deletedAssessmentsTaken() is invoked when the specified assessment taken is removed from this assessment bank.
      Parameters:
      assessmentTakenId - the Id of the AssessmentTaken to monitor
      Throws:
      NullArgumentException - assessmentTakenId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.