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

Class Supplier

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

Supplier composite

A group of data elements which together identify a specific supplier. Mandatory in each occurrence of the <SupplyDetail> composite, and not repeatable.

Reference name <Supplier>
Short tag <supplier>
Cardinality 1

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • Supplier

      public Supplier()

    • Supplier

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

    • ifExists

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

    • supplierRole

      public SupplierRole supplierRole()

      An ONIX code identifying the role of the supplier in relation to the product, eg Publisher, Publisher’s exclusive distributor, etc. Mandatory in each occurrence of the <Supplier> composite, and non-repeating.

      Jonix-Comment: this field is required

    • supplierIdentifiers

      public ListOfOnixDataCompositeWithKey<SupplierIdentifier,JonixSupplierIdentifier,SupplierIdentifierTypes> supplierIdentifiers()

      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.

      Jonix-Comment: this list is required to contain at least one item

    • supplierName

      public SupplierName supplierName()

      The name of a supply source from which the product may be ordered by a trade customer. Optional and non-repeating; required if no supplier identifier is sent.

      Jonix-Comment: this field is optional

    • telephoneNumbers

      public ListOfOnixElement<TelephoneNumber,String> telephoneNumbers()

      A telephone number of a supply source from which the product may be ordered by a trade customer. Optional and repeatable. Use to provide contact details for the organization as a whole, but prefer <SupplyContact> for individual functions or contacts within the organization.

      Jonix-Comment: this list may be empty

    • faxNumbers

      public ListOfOnixElement<FaxNumber,String> faxNumbers()

      A fax number of a supply source from which the product may be ordered by a trade customer. Optional and repeatable. Use to provide contact details for the organization as a whole, but prefer <SupplyContact> for individual functions or contacts within the organization.

      Jonix-Comment: this list may be empty

    • emailAddresss

      public ListOfOnixElement<EmailAddress,String> emailAddresss()

      An e‑mail address for a supply source from which the product may be ordered by a trade customer. Optional and repeatable. Use to provide contact details for the organization as a whole, but prefer <SupplyContact> for individual functions or contacts within the organization.

      Jonix-Comment: this list may be empty

    • websites

      public ListOfOnixDataComposite<Website,JonixWebsite> websites()

      An optional group of data elements which together identify and provide a pointer to a website which is related to the organization identified in an occurrence of the <Supplier> composite. Repeatable in order to provide links to multiple websites.

      Jonix-Comment: this list may be empty