Interface StockNotificationSession

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

This session defines methods to receive notifications on adds/changes to Stocks in this Warehouse . This also includes existing stocks that may appear or disappear due to changes in the Warehouse 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 StockLookupSession .

  • Method Details

    • getWarehouseId

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

    • getWarehouse

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

    • canRegisterForStockNotifications

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

    • useFederatedWarehouseView

      void useFederatedWarehouseView()
      Federates the view for methods in this session. A federated view will include stocks in catalogs which are children of this catalog in the warehouse hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedWarehouseView

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

    • reliableStockNotifications

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

    • unreliableStockNotifications

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

    • acknowledgeStockNotification

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

    • registerForNewStocks

      void registerForNewStocks() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new stocks. StockReceiver.newStocks() is invoked when a new Stock appears in this warehouse.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedStocks

      void registerForChangedStocks() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated stocks. StockReceiver.changedStocks() is invoked when a stock in this warehouse is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedStock

      void registerForChangedStock(Id stockId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated stock. StockReceiver.changedStocks() is invoked when the specified stock in this warehouse is changed.
      Parameters:
      stockId - the Id of the Stock to monitor
      Throws:
      NullArgumentException - stockId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedStocks

      void registerForDeletedStocks() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted stocks. StockReceiver.deletedStocks() is invoked when a stock is deleted or removed from this warehouse.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedStock

      void registerForDeletedStock(Id stockId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted stock. StockReceiver.deletedStocks() is invoked when the specified stock is deleted or removed from this warehouse.
      Parameters:
      stockId - the Id of the Stock to monitor
      Throws:
      NullArgumentException - stockId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedStockHierarchy

      void registerForChangedStockHierarchy() throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated stock hierarchy structure. StockReceiver.changedChildOfStocks() 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.

    • registerForChangedStockHierarchyForAncestors

      void registerForChangedStockHierarchyForAncestors(Id stockId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated stock hierarchy structure. StockReceiver.changedChildOfStocks() is invoked when a node experiences a change in its children.
      Parameters:
      stockId - the Id of the Stock node to monitor
      Throws:
      NullArgumentException - stockId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedStockHierarchyForDescendants

      void registerForChangedStockHierarchyForDescendants(Id stockId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated stock hierarchy structure. StockReceiver.changedChildOfStocks() is invoked when a node experiences a change in its children.
      Parameters:
      stockId - the Id of the Stock node to monitor
      Throws:
      NullArgumentException - stockId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.