Package com.tccc.kos.ext.dispense.troubles

Interface ContainerTroubleIface

All Superinterfaces:
com.tccc.kos.commons.core.service.trouble.TroubleIface
All Known Implementing Classes:
ContainerHolderTrouble, ContainerSliceTrouble, ContainerSoldOutTrouble, ContainerTrouble, SliceSoldOutTrouble, UnknownIngredientTrouble
public interface ContainerTroubleIface extends com.tccc.kos.commons.core.service.trouble.TroubleIface
Interface for Troubles that implements the container iface. This is a standard way to describe to external systems that the Trouble includes container information in a standard format.

Implementations must call ContainerTroubleiface.addIface(trouble) to ensure that external systems know the Trouble implements this interface.

This indicates the container interface is implemented and the following data is available:

  • containerId : Unique ID of the container
  • ingredients : List of ingredient IDs
Since:
1.0
Version:
2023-02-05

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    addIface(com.tccc.kos.commons.core.service.trouble.Trouble trouble)
    Adds the iface to the specified Trouble .
    String
    getContainerId()
    Returns the container ID.
    String[]
    getIngredients()
    Returns the ingredients in the container in slice order.

  • Method Details

    • addIface

      static void addIface(com.tccc.kos.commons.core.service.trouble.Trouble trouble)
      Adds the iface to the specified Trouble . Should be called in the Trouble constructor.
      Parameters:
      trouble - the Trouble to add the iface to

    • getContainerId

      String getContainerId()
      Returns the container ID.

    • getIngredients

      String[] getIngredients()
      Returns the ingredients in the container in slice order.