Package net.pricefx.formulaengine.scripting.queryapi.tables

Interface QapiProductBillOfMaterial

All Superinterfaces:
Map<String,SelectableExpression>, PersistedObjectColumns, Tables.Columns, Tables.Table
public interface QapiProductBillOfMaterial extends Tables.Table, PersistedObjectColumns
Table of the Bill of Materials (BoM) data. Each row is one component of a product: either a raw material or a sub-component, which is another product.

Example, the components of one product: 


 def q = api.queryApi()
 def bom = q.tables().productBillOfMaterials()

 return q.source(bom, [bom.type(), bom.rawMaterial(), bom.subComponentSku(), bom.quantity()],
         bom.sku().equal("MB-0001"))
         .stream { it.collect { it } }
Since:
15.3.13 - Southside, 16.0.4 - Black Cat
See Also:

  • Method Details

    • sku

      SelectableExpression sku()
      Returns the Stock Keeping Unit (SKU) of the product that the component belongs to.
      Returns:
      the sku column as a String expression
      See Also:

    • quantity

      SelectableExpression quantity()
      Returns how many units of the raw material or sub-component the product needs. The quantity has no unit of measure.
      Returns:
      the quantity column as a Real expression

    • category

      SelectableExpression category()
      Returns the category of the component.
      Returns:
      the category column as a String expression

    • rawMaterial

      SelectableExpression rawMaterial()
      Returns the name of the raw material, when the component is a raw material, or null when the component is a sub-component.
      Returns:
      the rawMaterial column as a String expression
      See Also:

    • subComponentSku

      SelectableExpression subComponentSku()
      Returns the Stock Keeping Unit (SKU) of the product used as a sub-component, when the component is another product, or null when the component is a raw material.
      Returns:
      the subComponentSku column as a String expression
      See Also:

    • type

      SelectableExpression type()
      Returns the type of the component: RAWMATERIAL or SUBCOMPONENT. A component is never both.
      Returns:
      the type column as an Enum expression

    • additionalInfo1

      SelectableExpression additionalInfo1()
      Returns the first additional numeric information of the component.
      Returns:
      the additionalInfo1 column as a Real expression

    • additionalInfo2

      SelectableExpression additionalInfo2()
      Returns the second additional numeric information of the component.
      Returns:
      the additionalInfo2 column as a Real expression

    • additionalInfo3

      SelectableExpression additionalInfo3()
      Returns the first additional text information of the component.
      Returns:
      the additionalInfo3 column as a String expression

    • additionalInfo4

      SelectableExpression additionalInfo4()
      Returns the second additional text information of the component.
      Returns:
      the additionalInfo4 column as a String expression

    • comments

      SelectableExpression comments()
      Returns the comments on the component.
      Returns:
      the comments column as a String expression