Interface SequenceRuleNotificationSession

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

This session defines methods to receive notifications on adds/changes to SequenceRule objects in this Bank . This also includes existing SequenceRules 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 SequenceRuleLookupSession .

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

    • canRegisterForSequenceRuleNotifications

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

    • reliableSequenceRuleNotifications

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

    • unreliableSequenceRuleNotifications

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

    • acknowledgeSequenceRuleNotification

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

    • registerForNewSequenceRules

      void registerForNewSequenceRules() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new sequence rules. SequenceRuleReceiver.newSequenceRules() is invoked when a new SequenceRule appears in this bank.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewSequenceRulesForAssessmentPart

      void registerForNewSequenceRulesForAssessmentPart(Id assessmentPartId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new sequence rules for the given assessment part. SequenceRuleReceiver.newSequenceRules() is invoked when a new SequenceRule appears in this bank.
      Parameters:
      assessmentPartId - the Id of the AssessmentPart to monitor
      Throws:
      NullArgumentException - sequenceRuleId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewSequenceRulesForNextAssessmentPart

      void registerForNewSequenceRulesForNextAssessmentPart(Id assessmentPartId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new sequence rules for the given assessment part. SequenceRuleReceiver.newSequenceRules() is invoked when a new SequenceRule appears in this bank.
      Parameters:
      assessmentPartId - the Id of the AssessmentPart to monitor
      Throws:
      NullArgumentException - sequenceRuleId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSequenceRules

      void registerForChangedSequenceRules() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated sequence rules. SequenceRuleReceiver.changedSequenceRules() is invoked when a sequence rule in this bank is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSequenceRulesForAssessmentPart

      void registerForChangedSequenceRulesForAssessmentPart(Id assessmentPartId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated sequence rules for the given assessment part. SequenceRuleReceiver.changedSequenceRules() is invoked when a new SequenceRule in this bank is changed.
      Parameters:
      assessmentPartId - the Id of the AssessmentPart to monitor
      Throws:
      NullArgumentException - sequenceRuleId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSequenceRulesForNextAssessmentPart

      void registerForChangedSequenceRulesForNextAssessmentPart(Id assessmentPartId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated sequence rules for the given assessment part. SequenceRuleReceiver.changedSequenceRules() is invoked when a new SequenceRule in this bank is changed.
      Parameters:
      assessmentPartId - the Id of the AssessmentPart to monitor
      Throws:
      NullArgumentException - sequenceRuleId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSequenceRule

      void registerForChangedSequenceRule(Id sequenceRuleId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated sequence rule. ProvisionableReceiver.changedSequenceRules() is invoked when the specified sequence rule in this bank is changed.
      Parameters:
      sequenceRuleId - the Id of the SequenceRule to monitor
      Throws:
      NullArgumentException - sequenceRuleId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSequenceRules

      void registerForDeletedSequenceRules() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted sequence rules. SequenceRuleReceiver.deletedSequenceRules() is invoked when a sequence rule is deleted or removed from this bank.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSequenceRulesForAssessmentPart

      void registerForDeletedSequenceRulesForAssessmentPart(Id assessmentPartId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted sequence rules for the given assessment part. SequenceRuleReceiver.deletedSequenceRule() is invoked when a sequence rule is deleted or removed from this bank.
      Parameters:
      assessmentPartId - the Id of the AssessmentPart to monitor
      Throws:
      NullArgumentException - sequenceRuleId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSequenceRulesForNextAssessmentPart

      void registerForDeletedSequenceRulesForNextAssessmentPart(Id assessmentPartId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted sequence rules for the given assessment part. SequenceRuleReceiver.deletedSequenceRule() is invoked when a sequence rule is deleted or removed from this bank.
      Parameters:
      assessmentPartId - the Id of the AssessmentPart to monitor
      Throws:
      NullArgumentException - sequenceRuleId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSequenceRule

      void registerForDeletedSequenceRule(Id sequenceRuleId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted sequence rule. SequenceRuleReceiver.deletedSequenceRule() is invoked when the specified sequence rule is deleted or removed from this bank.
      Parameters:
      sequenceRuleId - the Id of the SequenceRule to monitor
      Throws:
      NullArgumentException - sequenceRuleId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.