Interface InsertionHolderListener

All Superinterfaces:
InsertionListener
All Known Implementing Classes:
AssignmentService

public interface InsertionHolderListener extends InsertionListener
Interface to be notified when insertions and removals occur on holders. Once inserted into a holder, the container is connected to the associated pumps and is available for ingredient pouring for the purpose of completing the insertion process. For example, it may be necessary to prime a pump or container before it can be used for beverage pouring. These policies should be implemented as InsertionFilter to ensure that all policies are enforced.

Once all filters are passed, another event will be generated for each individual pump via the InsertionPumpListener.

Since:
1.0
Version:
2023-01-30
  • Method Details

    • onContainerInsertStart

      void onContainerInsertStart(Container container, Holder[] holders)
      Called when a container is inserted into one or more holders. This is called when the insertion request is first created and the container is linked to the holders. Availability to use the pumps will be subject to filters blocking the insert.
      Parameters:
      container - the container that was inserted
      holders - the holders inserted into
    • onContainerRemove

      void onContainerRemove(Container container, Holder[] holders)
      Called when a container is removed from holder(s).
      Parameters:
      container - the container that was removed
      holders - the associated holders