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

Class PriceCoded

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

Price coded composite

An optional group of data elements to carry a price that is expressed as one of a discrete set of price points, tiers or bands, rather than actual currency amounts. Each occurrence of the <Price> composite must include either a <PriceAmount> or a <PriceCoded> composite, with optional tax details, or an <UnpricedItemType> element.

Reference name <PriceCoded>
Short tag <pricecoded>
Cardinality 0…1

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • PriceCoded

      public PriceCoded()

    • PriceCoded

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

    • ifExists

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

    • priceCodeType

      public PriceCodeType priceCodeType()

      An ONIX code identifying the scheme from which the value in the <PriceCode> element is taken. Mandatory in an occurrence of the <PriceCoded> composite, and non-repeating.

      Jonix-Comment: this field is required

    • priceCode

      public PriceCode priceCode()

      A price code from the scheme specified in the <PriceCodeType> element. Mandatory in each occurrence of the <PriceCoded> composite, and non-repeating.

      Jonix-Comment: this field is required

    • priceCodeTypeName

      public PriceCodeTypeName priceCodeTypeName()

      A name which identifies a proprietary price code type. Must be used when, and only when the code in the <PriceCodeType> element indicates a proprietary scheme, eg a retailer’s price banding scheme. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • asStruct

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

    • structKey

      public PriceCodeTypes structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixPriceCoded,PriceCodeTypes>