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

Class ProductClassification

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

Product classification composite

An optional group of data elements which together define a product classification (not to be confused with a subject classification). The intended use is to enable national or international trade classifications (also known as commodity codes) to be carried in an ONIX record. The composite is repeatable if parts of the product are classified differently within a single product classification scheme, or to provide classification codes from multiple classification schemes.

Reference name <ProductClassification>
Short tag <productclassification>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • ProductClassification

      public ProductClassification()

    • ProductClassification

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

    • ifExists

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

    • productClassificationType

      public ProductClassificationType productClassificationType()

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

      Jonix-Comment: this field is required

    • productClassificationCode

      public ProductClassificationCode productClassificationCode()

      A classification code from the scheme specified in <ProductClassificationType>. Mandatory in each occurrence of the <ProductClassification> composite, and non-repeating.

      Jonix-Comment: this field is required

    • productClassificationTypeName

      public ProductClassificationTypeName productClassificationTypeName()

      A name which identifies a proprietary classification scheme (ie a scheme which is not a standard and for which there is no individual scheme type code). Should be included when, and only when, the code in the <ProductClassificationType> element indicates a proprietary scheme, ie the sender’s own category scheme. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • percent

      public Percent percent()

      The percentage of the unit value of the product that is assignable to a designated product classification. Optional and non-repeating. Used when a mixed product (eg book and CD) belongs partly to two or more product classes within a particular scheme. If omitted, the product classification code applies to 100% of the product.

      Jonix-Comment: this field is optional

    • asStruct

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

    • structKey

      public ProductClassificationTypes structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixProductClassification,ProductClassificationTypes>