Interface AssessmentPartNotificationSession

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

This session defines methods to receive notifications on adds/changes to AssessmentPart objects in this Bank . This also includes existing AssessmentParts that may appear or disappear due to changes in the Bank 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 AssessmentPartLookupSession .

  • 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
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForAssessmentPartNotifications

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

    • reliableAssessmentPartNotifications

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

    • unreliableAssessmentPartNotifications

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

    • acknowledgeAssessmentPartNotification

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

    • registerForNewAssessmentParts

      void registerForNewAssessmentParts() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new assessment parts. AssessmentPartReceiver.newAssessmentParst() is invoked when a new AssessmentPart appears in this bank.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAssessmentParts

      void registerForChangedAssessmentParts() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated bank. AssessmentPartReceiver.changedAssessmentParts() is invoked when an assessment part in this bank is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAssessmentPart

      void registerForChangedAssessmentPart(Id assessmentPartId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of an updated assessment part. ProvisionableReceiver.changedAssessmentParts() is invoked when the specified assessment part in this bank is changed.
      Parameters:
      assessmentPartId - the Id of the AssessmentPart to monitor
      Throws:
      NotFoundException - an assessment part was not found in this step matchmaker identified by the given Id
      NullArgumentException - assessmentPartId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAssessmentParts

      void registerForDeletedAssessmentParts() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted assessment parts. AssessmentPartReceiver.deletedAssessmentParts() is invoked when an assessment part is deleted or removed from this bank.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAssessmentPart

      void registerForDeletedAssessmentPart(Id assessmentPartId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted assessment part. AssessmentPartReceiver.deletedAssessmentParts() is invoked when the specified assessment part is deleted or removed from this bank.
      Parameters:
      assessmentPartId - the Id of the AssessmentPart to monitor
      Throws:
      NotFoundException - an assessment part was not found in this step matchmaker identified by the given Id
      NullArgumentException - assessmentPartId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.