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

Class PromotionalEvent

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

Promotional event composite

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.

Reference name <PromotionalEvent>
Short tag <promotionalevent>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-3.07
See Also:

  • Field Details

  • Constructor Details

    • PromotionalEvent

      public PromotionalEvent()

    • PromotionalEvent

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

    • ifExists

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

    • eventTypes

      public ListOfOnixCodelist<EventType,EventTypes> eventTypes()

      A mandatory ONIX code which specifies the type of promotional event. Repeatable for promotional events which combine different event types.

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

    • contentAudiences

      public ListOfOnixCodelist<ContentAudience,ContentAudiences> contentAudiences()

      An ONIX code which identifies the audience for which a promotional event is intended. Mandatory within in each instance of the <PromotionalEvent> composite, and repeatable.

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

    • eventNames

      public ListOfOnixElement<EventName,String> eventNames()

      The name of or headline for a promotional event or series of events which relate to the product. This element is mandatory within each instance of the <PromotionalEvent> composite, and repeatable to provide parallel names for a single event in multiple languages. The language attribute is optional for a single instance of <EventName>, but must be included in each instance if <EventName> is repeated.

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

    • contributorReferences

      public ListOfOnixComposite<ContributorReference> contributorReferences()

      Optional composite that identifies a contributor – a person or corporate body – participating in the promotional event who is also a contributor to the product, or who is its subject (ie who is fully described in an instance of the <Contributor> composite within Groups P.5, P.7 or P.18, or in an instance of <NameAsSubject> within Groups P.12 or P.18, in the same Product record). Repeatable to refer to multiple contributors.

      Note that an instance of <PromotionalEvent> may also contain one or more <Contributor> composites – the latter listing participants to the event who are not contributors to the product.

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

    • eventOccurrences

      public ListOfOnixComposite<EventOccurrence> eventOccurrences()

      A group of data elements which together describe a single occurrence of the promotional event. At least one occurrence is mandatory within the <PromotionalEvent> composite, and <EventOccurrence> is repeatable in order to list a group of more or less similar occurrences such as a series of book signings.

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

    • eventStatus

      public EventStatus eventStatus()

      An ONIX code which specifies the status of a promotional event. Optional within each instance of the <PromotionalEvent> composite, and non-repeatable.

      Jonix-Comment: this field is optional

    • noContributor

      public NoContributor noContributor()

      An empty element that provides a positive indication that a promotional event has no named participants. Optional and non-repeating. Must only be sent in a <PromotionalEvent> composite that has neither <ContributorReference> nor <Contributor> composites.

      Jonix-Comment: this field is optional

    • isNoContributor

      public boolean isNoContributor()

    • eventIdentifiers

      public ListOfOnixDataCompositeWithKey<EventIdentifier,JonixEventIdentifier,EventIdentifierTypes> eventIdentifiers()

      An optional group of data elements which together define an identifier for an event. The composite is repeatable in order to specify multiple identifiers for the same event.

      Jonix-Comment: this list may be empty

    • contributors

      public ListOfOnixComposite<Contributor> contributors()

      Optional composite that describes a contributor – a person or corporate body – participating in the promotional event who is neither a contributor to the product, nor its subject (ie is not described in an instance of the <Contributor> composite within Groups P.5, P.7 or P.18, or in an instance of <NameAsSubject> within Groups P.12 or P.18, in the same Product record). Repeatable to identify multiple contributors.

      Jonix-Comment: this list may be empty

    • contributorStatements

      public ListOfOnixElement<ContributorStatement,String> contributorStatements()

      Free text showing how the participants at a promotional event should be described in an online display, when a standard concatenation of individual Contributor reference and Contributor elements would not give a satisfactory presentation. Optional, and repeatable if parallel text is provided in multiple languages. The language attribute is optional for a single instance of <ContributorStatement>, but must be included in each instance if <ContributorStatement> is repeated. When the <ContributorStatement> field is sent, the receiver should use it to replace all name detail (though not the biographical, date or place details) sent in the <Contributor> composites for display purposes only for the promotional event. The individual name detail must also be sent in the <ContributorReference> and <Contributor> composites for indexing and retrieval.

      Jonix-Comment: this list may be empty

    • eventDescriptions

      public ListOfOnixElement<EventDescription,String> eventDescriptions()

      Free text describing the promotional event as a whole. Optional, and repeatable if parallel text is provided in multiple languages. The language attribute is optional for a single instance of <EventDescription>, but must be included in each instance if <EventDescription> is repeated.

      Jonix-Comment: this list may be empty

    • supportingResources

      public ListOfOnixComposite<SupportingResource> supportingResources()

      An optional group of data elements which together describe a supporting resource related to a promotional event. 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

    • eventSponsors

      public ListOfOnixComposite<EventSponsor> eventSponsors()

      An optional group of data elements which together identify an organizer or sponsor of an event or series of event occurrences. Either an <EventSponsorIdentifier>, or one or other of <PersonName> or <CorporateName>, or both an identifier and a name, must be present in each occurrence of the composite. The composite is repeatable in order to specify multiple organizers and sponsors.

      Jonix-Comment: this list may be empty

    • websites

      public ListOfOnixDataComposite<Website,JonixWebsite> websites()

      An optional group of data elements which together identify and provide pointers to a website which is related to the event in an instance of the <PromotionalEvent> composite. Repeatable to provide links to multiple websites.

      Jonix-Comment: this list may be empty