Module jonix.onix3
Package com.tectonica.jonix.onix3

Class OnOrderDetail

java.lang.Object
com.tectonica.jonix.onix3.OnOrderDetail
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixDataComposite<JonixOnOrderDetail>, OnixTag, Serializable
public class OnOrderDetail extends Object implements OnixComposite.OnixDataComposite<JonixOnOrderDetail>, Serializable

On order detail composite

A repeatable group of data elements which together specify details of a stock shipment currently awaited, normally from overseas. Optional and repeatable if more than a single shipment is outstanding.

Note that quantities in the <OnOrderDetail> composite must be included in any total quantity on order given in P.26.37 <OnOrder>, and detail need not be given for all outstanding shipments (ie the P.26.37 <OnOrder> must be greater than or equal to the total of the <OnOrder> elements in repeats of the composite).

Reference name <OnOrderDetail>
Short tag <onorderdetail>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • OnOrderDetail

      public OnOrderDetail()

    • OnOrderDetail

      public OnOrderDetail(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 (<OnOrderDetail> or <onorderdetail>) is explicitly provided in the ONIX XML

    • ifExists

      public void ifExists(Consumer<OnOrderDetail> 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

    • onOrder

      public OnOrder onOrder()

      The quantity of stock on order in a particular shipment. Mandatory in each occurrence of the <OnOrderDetail> composite, and non-repeating.

      Jonix-Comment: this field is required

    • expectedDate

      public ExpectedDate expectedDate()

      The date on which a stock shipment is expected. Mandatory in each occurrence of the <OnOrderDetail> composite, and non-repeating.

      Jonix-Comment: this field is required

    • proximity

      public Proximity proximity()

      An ONIX code which specifies the precision of the stock quantity in a shipment. Optional, and non-repeating.

      Jonix-Comment: this field is optional

    • asStruct

      public JonixOnOrderDetail asStruct()
      Specified by:
      asStruct in interface OnixComposite.OnixDataComposite<JonixOnOrderDetail>