Interface FoundryNotificationSession

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

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

    • canRegisterForFoundryNotifications

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

    • reliableFoundryNotifications

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

    • unreliableFoundryNotifications

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

    • acknowledgeFoundryNotification

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

    • registerForNewFoundries

      void registerForNewFoundries() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new foundries. FoundryReceiver.newFoundries() is invoked when a new Foundry is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedFoundries

      void registerForChangedFoundries() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated foundries. FoundryReceiver.changedFoundries() is invoked when a foundry is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedFoundry

      void registerForChangedFoundry(Id foundryId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated foundry. FoundryReceiver.changedFoundries() is invoked when the specified foundry is changed.
      Parameters:
      foundryId - the Id of the Foundry to monitor
      Throws:
      NullArgumentException - foundryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedFoundries

      void registerForDeletedFoundries() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted foundries. FoundryReceiver.deletedFoundries() is invoked when a foundry is deleted.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedFoundry

      void registerForDeletedFoundry(Id foundryId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted foundry. FoundryReceiver.deletedFoundries() is invoked when the specified foundry is deleted.
      Parameters:
      foundryId - the Id of the Foundry to monitor
      Throws:
      NullArgumentException - foundryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedFoundryHierarchy

      void registerForChangedFoundryHierarchy() throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated foundry hierarchy structure. FoundryReceiver.changedChildOfFoundries() is invoked when the specified node or any of its descendants experiences a change in its children.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedFoundryHierarchyForAncestors

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

    • registerForChangedFoundryHierarchyForDescendants

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