Interface AntimatroidNotificationSession

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

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

  • Method Details

    • canRegisterForAntimatroidNotifications

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

    • reliableAntimatroidNotifications

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

    • unreliableAntimatroidNotifications

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

    • acknowledgeAntimatroidNotification

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

    • registerForNewAntimatroids

      void registerForNewAntimatroids() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new antimatroids. AntimatroidReceiver.newAntimatroids() is invoked when a new Antimatroid is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAntimatroids

      void registerForChangedAntimatroids() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated antimatroids. AntimatroidReceiver.changedAntimatroids() is invoked when an antimatroid is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAntimatroid

      void registerForChangedAntimatroid(Id antimatroidId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated antimatroid. AntimatroidReceiver.changedAntimatroids() is invoked when the specified antimatroid is changed.
      Parameters:
      antimatroidId - the Id of the Antimatroid to monitor
      Throws:
      NullArgumentException - antimatroidId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAntimatroids

      void registerForDeletedAntimatroids() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted antimatroids. AntimatroidReceiver.deletedAntimatroids() is invoked when an antimatroid is deleted.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAntimatroid

      void registerForDeletedAntimatroid(Id antimatroidId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted antimatroid. AntimatroidReceiver.deletedAntimatroids() is invoked when the specified antimatroid is deleted.
      Parameters:
      antimatroidId - the Id of the Antimatroid to monitor
      Throws:
      NullArgumentException - antimatroidId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAntimatroidHierarchy

      void registerForChangedAntimatroidHierarchy() throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated antimatroid hierarchy structure. AntimatroidReceiver.changedChildOfAntimatroids() 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.

    • registerForChangedAntimatroidHierarchyForAncestors

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

    • registerForChangedAntimatroidHierarchyForDescendants

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