Interface QualifierNotificationSession

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

This session defines methods to receive notifications on adds/changes to Qualifier objects in this Vault . 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 QualifierLookupSession .

  • Method Details

    • getVaultId

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

    • getVault

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

    • canRegisterForQualifierNotifications

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

    • useFederatedVaultView

      void useFederatedVaultView()
      Federates the view for methods in this session. A federated view will include notifications for qualifiers in vaults which are children of this vault in the vault hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedVaultView

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

    • reliableQualifierNotifications

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

    • unreliableQualifierNotifications

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

    • acknowledgeQualifierNotification

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

    • registerForNewQualifiers

      void registerForNewQualifiers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new qualifiers. QualifierReceiver.newQualifiers() is invoked when a new Qualifier is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQualifiers

      void registerForChangedQualifiers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated qualifiers. QualifierReceiver.changedQualifiers() is invoked when a qualifier is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQualifier

      void registerForChangedQualifier(Id qualifierId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated qualifier. QualifierReceiver.changedQualifiers() is invoked when the specified qualifier is changed.
      Parameters:
      qualifierId - the Id of the Qualifier to monitor
      Throws:
      NullArgumentException - qualifierId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedQualifiers

      void registerForDeletedQualifiers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted qualifiers. QualifierReceiver.deletedQualifiers() is invoked when a qualifier is removed from this vault.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedQualifier

      void registerForDeletedQualifier(Id qualifierId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted qualifier. QualifierReceiver.deletedQualifiers() is invoked when the specified qualifier is removed from this vault.
      Parameters:
      qualifierId - the Id of the Qualifier to monitor
      Throws:
      NullArgumentException - qualifierId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQualifierHierarchy

      void registerForChangedQualifierHierarchy() throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated qualifier hierarchy structure. QualifierReceiver.changedChildOfQualfiers() is invoked when a node experiences a change in its children.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQualifierHierarchyForAncestors

      void registerForChangedQualifierHierarchyForAncestors(Id qualifierId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated qualifier hierarchy structure. QualifierReceiver.changedChildOfQualifiers() is invoked when the specified node or any of its ancestors experiences a change in its children.
      Parameters:
      qualifierId - the Id of the Qualifier node to monitor
      Throws:
      NullArgumentException - qualifierId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQualifierHierarchyForDescendants

      void registerForChangedQualifierHierarchyForDescendants(Id qualifierId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated qualifier hierarchy structure. QualifierReceiver.changedChildOfQualifiers() is invoked when the specified node or any of its descendants experiences a change in its children.
      Parameters:
      qualifierId - the Id of the Qualifier node to monitor
      Throws:
      NullArgumentException - qualifierId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.