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

Class SalesOutletIdentifier

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

Sales outlet identifier composite

An optional group of data elements which together represent a coded identification of an organization, used here to identify a sales outlet. Repeatable in order to specify multiple identifiers for the same sales outlet.

Reference name <SalesOutletIdentifier>
Short tag <salesoutletidentifier>
Cardinality 0…n

Technical notes about <SalesOutletIdentifier> from the schema author: Identifier for a specific retail outlet, eg one associated with sales exclusivity This tag may be included in the following composites:

Possible placements within ONIX message:
Since:
Onix-3.02
See Also:

  • Field Details

  • Constructor Details

    • SalesOutletIdentifier

      public SalesOutletIdentifier()

    • SalesOutletIdentifier

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

    • ifExists

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

    • salesOutletIDType

      public SalesOutletIDType salesOutletIDType()

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

      JONIX adds: this field is required

    • idValue

      public IDValue idValue()

      A code value taken from the scheme specified in the <SalesOutletIDType> element. Mandatory in each occurrence of the <SalesOutletIdentifier> 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 <SalesOutletIDType> element indicates a proprietary scheme. Optional and non-repeating.

      JONIX adds: this field is optional

    • asStruct

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

    • structKey

      public SalesOutletIdentifierTypes structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixSalesOutletIdentifier,SalesOutletIdentifierTypes>