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

Class PromotionDetail

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

Promotion detail composite

The promotion detail block comprises the single data Group P.27. The block as a whole is optional and non-repeating, and is used only when there is a need to describe various promotional events intended to promote the product in a structured way. When used, the block usually consists of one or more instances of <PromotionalEvent>. 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 promotion detail.

Reference name <PromotionDetail>
Short tag <promotiondetail>
Cardinality 0…1

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-3.07
See Also:

  • Field Details

  • Constructor Details

    • PromotionDetail

      public PromotionDetail()

    • PromotionDetail

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

    • ifExists

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

    • promotionalEvents

      public ListOfOnixComposite<PromotionalEvent> promotionalEvents()

      An group of data elements which together describe a promotional event or series of event occurrences such as an author tour. Optional in any occurrence of the <PromotionDetail> composite, but it may be omitted 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 promotional event detail. When used normally, it is repeatable to describe multiple events linked to promotion of the product.

      The promotional event composite must contain at least one <EventOccurrence>. It may optionally contain one or more contributors to the event, listing those that are also contributors to the product using <ContributorReference> and those that are not contributors to the product using <Contributor>. If there are no contributors to the event of either type, an optional <NoContributor/> flag may be included instead.

      Jonix-Comment: this list may be empty