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

Class CollateralDetail

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

Collateral detail composite

The collateral detail block covers data Groups P.14 to P.17, all of which are primarily concerned with information and/or resources which in one way or another support the marketing of the product. The block as a whole is non-repeating.

The block is not mandatory within the <Product> record, nor are any of the individual sections mandatory within an occurrence of the block. However, in most circumstances, the block should contain at least one instance of <TextContent>, <CitedContent>, <SupportingResource> or <Prize>. It may be empty only within a partial or ‘block update’ (Notification or update type 04, see P.1.2), when the intention is to remove all previously-supplied collateral material.

Reference name <CollateralDetail>
Short tag <collateraldetail>
Cardinality 0…1

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • CollateralDetail

      public CollateralDetail()

    • CollateralDetail

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

    • ifExists

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

    • textContents

      public ListOfOnixComposite<TextContent> textContents()

      An optional group of data elements which together carry a supporting text related to the product, repeatable in order to deliver multiple texts (often of different types, though for some text types there many be multiple instances of that type).

      Jonix-Comment: this list may be empty

    • citedContents

      public ListOfOnixComposite<CitedContent> citedContents()

      An optional group of data elements which together describe a piece of cited content. The composite is repeatable to describe and link to multiple items of cited material.

      Jonix-Comment: this list may be empty

    • supportingResources

      public ListOfOnixComposite<SupportingResource> supportingResources()

      An optional group of data elements which together describe a supporting resource. The composite is repeatable to describe and link to multiple resources. Note that different forms of the same resource (for example a cover image in separate low and high resolution versions) should be specified in a single instance of the composite.

      Jonix-Comment: this list may be empty

    • prizes

      public ListOfOnixComposite<Prize> prizes()

      An optional group of data elements which together describe a prize or award won by the product or work, and repeatable where it has gained multiple prizes or awards.

      Jonix-Comment: this list may be empty