Module jonix.onix2
Package com.tectonica.jonix.onix2

Class Stock

java.lang.Object
com.tectonica.jonix.onix2.Stock
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixSuperComposite, OnixTag, Serializable
public class Stock extends Object implements OnixComposite.OnixSuperComposite, Serializable

Stock quantity composite

A repeatable group of data elements which together specify a quantity of stock and, where a supplier has more than one warehouse, a supplier location. Optional.

Reference name <Stock>
Short tag <stock>

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-2.1
See Also:

  • Field Details

  • Constructor Details

    • Stock

      public Stock()

    • Stock

      public Stock(Element element)

  • Method Details

    • _initialize

      public void _initialize()
      Description copied from interface: OnixComposite
      This is an internal API. Since Jonix 8.0, composite objects are being populated lazily. This method initiates the population process, and is invoked internally by the accessor APIs of the composites
      Specified by:
      _initialize in interface OnixComposite

    • exists

      public boolean exists()
      Description copied from interface: OnixTag
      indicates whether this tag exists in the ONIX record
      Specified by:
      exists in interface OnixTag
      Returns:
      whether this tag (<Stock> or <stock>) is explicitly provided in the ONIX XML

    • ifExists

      public void ifExists(Consumer<Stock> action)

    • getXmlElement

      public Element getXmlElement()
      Description copied from interface: OnixComposite
      For advanced use-cases only.
      Specified by:
      getXmlElement in interface OnixComposite
      Returns:
      native representation of the XML element underlying to this tag

    • stockQuantityCoded

      public StockQuantityCoded stockQuantityCoded()

      A group of data elements which together specify coded stock level without stating the exact quantity of stock. Either <StockQuantityCoded> or <OnHand> is mandatory in each occurrence of the <Stock> composite, even if the onhand quantity is zero. Non-repeating.

      Jonix-Comment: this field is required

    • locationIdentifier

      public LocationIdentifier locationIdentifier()

      A group of data elements which together define the identifier of a stock location in accordance with a specified scheme, and allowing different types of location identifier to be supported without defining additional data elements. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • locationName

      public LocationName locationName()

      The name of a stock location. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • onHand

      public OnHand onHand()

      The quantity of stock on hand. Either <StockQuantityCoded> or <OnHand> is mandatory in each occurrence of the <Stock> composite, even if the onhand quantity is zero. Non-repeating.

      Jonix-Comment: this field is optional

    • onOrder

      public OnOrder onOrder()

      The quantity of stock on order. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • cbo

      public CBO cbo()

      The quantity of stock on order which is already committed to meet backorders. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • onOrderDetails

      public ListOfOnixDataComposite<OnOrderDetail,JonixOnOrderDetail> onOrderDetails()

      A repeatable group of data elements which together specify details of a stock shipment currently awaited, normally from overseas. Optional.

      Jonix-Comment: this list may be empty