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

Class SupplierIdentifier

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

Supplier identifier composite

A group of data elements which together specify an identifier of the supplier in accordance with a specified scheme, and repeatable to allow different types of supplier identifier to be included without defining additional data elements. Optional, but each occurrence of the <Supplier> composite must carry either at least one supplier identifier, or a <SupplierName>, or both.

Reference name <SupplierIdentifier>
Short tag <supplieridentifier>
Cardinality 0…n

Technical notes about <SupplierIdentifier> from the schema author: Identifier for a supplier organization This tag may be included in the following composites:

Possible placements within ONIX message:
See Also:

  • Field Details

  • Constructor Details

    • SupplierIdentifier

      public SupplierIdentifier()

    • SupplierIdentifier

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

    • ifExists

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

    • supplierIDType

      public SupplierIDType supplierIDType()

      An ONIX code identifying the scheme from which the identifier in the <IDValue> element is taken. Mandatory in each occurrence of the <SupplierIdentifier> composite, and non-repeating.

      JONIX adds: this field is required

    • idValue

      public IDValue idValue()

      An identifier of the type specified in the <SupplierIDType> element. Mandatory in each occurrence of the <SupplierIdentifier> composite, and non-repeating.

      JONIX adds: this field is required

    • idTypeName

      public IDTypeName idTypeName()

      A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <SupplierIDType> element indicates a proprietary scheme, eg a wholesaler’s own code. Optional and non-repeating.

      JONIX adds: this field is optional

    • asStruct

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

    • structKey

      public SupplierIdentifierTypes structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixSupplierIdentifier,SupplierIdentifierTypes>