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

Class RelatedProduct

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

Related product composite (content item)

A group of data elements which together describe a product which has a specified relationship to a content item. Optional and repeatable.

Reference name <RelatedProduct>
Short tag <relatedproduct>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-3.03
See Also:

  • Field Details

  • Constructor Details

    • RelatedProduct

      public RelatedProduct()

    • RelatedProduct

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

    • ifExists

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

    • productRelationCodes

      public ListOfOnixCodelist<ProductRelationCode,ProductRelations> productRelationCodes()

      An ONIX code which identifies the nature of the relationship between two products, eg ‘replaced-by’. Mandatory in each occurrence of the <RelatedProduct> composite, and repeatable where the related product has multiple types of relationship to the product described.

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

    • productIdentifiers

      public ListOfOnixDataCompositeWithKey<ProductIdentifier,JonixProductIdentifier,ProductIdentifierTypes> productIdentifiers()

      A group of data elements which together define an identifier of a product in accordance with a specified scheme. Mandatory in each occurrence of the <RelatedProduct> composite. Repeatable only if two or more identifiers for the same product are sent using different identifier schemes.

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

    • productForm

      public ProductForm productForm()

      An ONIX code which indicates the primary form of a related product. Optional in an occurrence of <RelatedProduct>, and non-repeating. If supplied, should be identical to the <ProductForm> element supplied in the <DescriptiveDetail> block of the full ONIX record describing the related product itself.

      Since this and the following element provide data about a related product, ONIX suppliers are cautioned of the risk of contradictory data in separate data feeds. This and the following element should not be supplied unless specifically requested by a particular recipient.

      Jonix-Comment: this field is optional

    • productFormDetails

      public ListOfOnixCodelist<ProductFormDetail,ProductFormDetails> productFormDetails()

      An ONIX code which provides added detail of the medium and/or format of a related product. Optional and repeatable.

      Jonix-Comment: this list may be empty