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

Class ReturnsConditions

java.lang.Object
com.tectonica.jonix.onix3.ReturnsConditions
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixDataComposite<JonixReturnsConditions>, OnixComposite.OnixDataCompositeWithKey<JonixReturnsConditions,ReturnsConditionsCodeTypes>, OnixTag, Serializable
public class ReturnsConditions extends Object implements OnixComposite.OnixDataCompositeWithKey<JonixReturnsConditions,ReturnsConditionsCodeTypes>, Serializable

Returns conditions composite

An optional and repeatable group of data elements which together allow the supplier’s returns conditions to be specified in coded form.

Reference name <ReturnsConditions>
Short tag <returnsconditions>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • ReturnsConditions

      public ReturnsConditions()

    • ReturnsConditions

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

    • ifExists

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

    • returnsCodeType

      public ReturnsCodeType returnsCodeType()

      An ONIX code identifying the scheme from which the returns conditions code in <ReturnsCode> is taken. Mandatory in each occurrence of the <ReturnsConditions> composite, and non-repeating.

      Jonix-Comment: this field is required

    • returnsCode

      public ReturnsCode returnsCode()

      A returns conditions code from the scheme specified in <ReturnsCodeType>. Mandatory in each occurrence of the <ReturnsConditions> composite, and non-repeating.

      Jonix-Comment: this field is required

    • returnsCodeTypeName

      public ReturnsCodeTypeName returnsCodeTypeName()

      A name which identifies a proprietary returns code scheme. Must be used when, and only when, the code in the <ReturnsCodeType> element indicates a proprietary scheme, eg a wholesaler’s own code. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • returnsNotes

      public ListOfOnixElement<ReturnsNote,String> returnsNotes()

      Free text note explaining the returns conditions or special returns instructions, where the code alone is not sufficient. Optional, and repeatable if parallel text is provided in multiple languages. The language attribute is optional for a single instance of <ReturnsNote>, but must be included in each instance if <ReturnsNote> is repeated.

      Jonix-Comment: this list may be empty

    • asStruct

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

    • structKey

      public ReturnsConditionsCodeTypes structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixReturnsConditions,ReturnsConditionsCodeTypes>