Module jonix.onix2
Package com.tectonica.jonix.onix2

Class ProductFormFeature

java.lang.Object
com.tectonica.jonix.onix2.ProductFormFeature
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixDataComposite<JonixProductFormFeature>, OnixComposite.OnixDataCompositeWithKey<JonixProductFormFeature,ProductFormFeatureTypes>, OnixTag, Serializable
public class ProductFormFeature extends Object implements OnixComposite.OnixDataCompositeWithKey<JonixProductFormFeature,ProductFormFeatureTypes>, Serializable

Product form feature composite

A repeatable group of data elements which together describe an aspect of product form that is too specific to be covered in the <ProductForm> and <ProductFormDetail> elements. Optional.

Reference name <ProductFormFeature>
Short tag <productformfeature>

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-2.1
See Also:

  • Field Details

  • Constructor Details

    • ProductFormFeature

      public ProductFormFeature()

    • ProductFormFeature

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

    • ifExists

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

    • productFormFeatureType

      public ProductFormFeatureType productFormFeatureType()

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

      Jonix-Comment: this field is required

    • productFormFeatureValue

      public ProductFormFeatureValue productFormFeatureValue()

      A controlled value that describes a product form feature. Presence or absence of this element depends on the <ProductFormFeatureType>, since some product form features (eg thumb index) do not require an accompanying value, while others (eg text font) require free text in <ProductFormFeatureDescription>. Non-repeating.

      Jonix-Comment: this field is optional

    • productFormFeatureDescription

      public ProductFormFeatureDescription productFormFeatureDescription()

      If the <ProductFormFeatureType> requires free text rather than a code value, or if the code in <ProductFormFeatureValue> does not adequately describe the feature, a short text description may be added. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • asStruct

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

    • structKey

      public ProductFormFeatureTypes structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixProductFormFeature,ProductFormFeatureTypes>