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

Class SpecificationFeature

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

Specification feature composite

An optional group of data elements which together specify an aspect of the body of the Product or Product part that is too specific to be covered in the <SpecificationDetail> element. Repeatable in order to describe different aspects of the product form.

Reference name <SpecificationFeature>
Short tag <specificationfeature>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-3.08
See Also:

  • Field Details

  • Constructor Details

    • SpecificationFeature

      public SpecificationFeature()

    • SpecificationFeature

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

    • ifExists

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

    • specificationFeatureType

      public SpecificationFeatureType specificationFeatureType()

      An ONIX code which specifies the feature described by an instance of the <SpecificationFeature> composite, eg paper color for the body. Mandatory in each occurrence of the composite, and non-repeating.

      Jonix-Comment: this field is required

    • specificationFeatureValue

      public SpecificationFeatureValue specificationFeatureValue()

      A controlled value that specifies a feature of the body of the product. Presence or absence of this element depends on the <SpecificationFeatureType>, since some feature types may not require an accompanying value, while others may require free text in <SpecificationFeatureDescription> and some may have both controlled value and free text. Non-repeating.

      Jonix-Comment: this field is optional

    • specificationFeatureDescriptions

      public ListOfOnixElement<SpecificationFeatureDescription,String> specificationFeatureDescriptions()

      If the <SpecificationFeatureType> requires free text rather than a controlled value, or if the code in <SpecificationFeatureValue> does not adequately specify the feature of the body, a short text description may be added. Optional, and repeatable to provide parallel descriptive text in multiple languages. The language attribute is optional for a single instance of <SpecificationFeatureDescription>, but must be included in each instance if <SpecificationFeatureDescription> is repeated.

      Jonix-Comment: this list may be empty

    • asStruct

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

    • structKey

      public SpecificationFeatureTypes structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixSpecificationFeature,SpecificationFeatureTypes>