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

Class EventOccurrence

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

Event occurrence composite

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.

Reference name <EventOccurrence>
Short tag <eventoccurrence>
Cardinality 1…n

Technical notes about <EventOccurrence> from the schema author: Details for a particular occurrence of an event promoting the product ● Added <PostalCode> at revision 3.1.2 ● Added <SupportingResource> at revision 3.0.8 ● Added at revision 3.0.7 This tag may be included in the following composites:

Possible placements within ONIX message:
Since:
Onix-3.07
See Also:

  • Field Details

  • Constructor Details

    • EventOccurrence

      public EventOccurrence()

    • EventOccurrence

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

    • ifExists

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

    • eventStatus

      public EventStatus eventStatus()

      An ONIX code which specifies the status of a particular occurrence of a promotional event occurrence. Mandatory within each instance of the <EventOccurrence> composite, and non-repeatable.

      JONIX adds: this field is required

    • countryCode

      public CountryCode countryCode()

      An ONIX code identifying a country within which an event occurrence takes place. Optional and non-repeatable. For a physical event, at least one of the <CountryCode> or <RegionCode> elements is required in each instance of <EventOccurrence>. For purely digital events, both must be omitted.

      JONIX adds: this field is required

    • occurrenceDates

      public ListOfOnixDataCompositeWithKey<OccurrenceDate,JonixOccurrenceDate,EventOccurrenceDateRoles> occurrenceDates()

      A group of data elements which together specify a date associated with the event occurrence. At least the date (and typically also the time) the event occurrence begins must be specified, and other dates related to the event occurrence can be sent in further repeats of the composite.

      JONIX adds: this list is required to contain at least one item

    • regionCode

      public RegionCode regionCode()

      An ONIX code identifying a region within which an event occurrence takes place. Optional and non-repeatable. For a physical event, at least one of the <CountryCode> or <RegionCode> elements is required in each instance of <EventOccurrence>. For purely digital events, both must be omitted.

      JONIX adds: this field is optional

    • venueName

      public VenueName venueName()

      The name of the venue at which the event occurrence takes place, for example the name of the bookstore. Optional, but required for a physical event and omitted for a purely digital event.

      JONIX adds: this field is optional

    • streetAddress

      public StreetAddress streetAddress()

      The street address of the named venue. Optional, but typically required for physical events and omitted for a purely digital event. Care should be taken that if the Street address is provided, then the Venue name, Street address, Location name, any Postal code or Region code, and the Country code can be combined into a complete postal address, without repetition.

      JONIX adds: this field is optional

    • postalCode

      public PostalCode postalCode()

      The postal code (postcode, zip code etc), forming part of the postal address of the venue. Optional and non-repeatable if a Street address is present, but otherwise omitted.

      JONIX adds: this field is optional

    • eventIdentifiers

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

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

      JONIX adds: this list may be empty

    • locationNames

      public ListOfOnixElement<LocationName,String> locationNames()

      The name of a city or town location within the specified country or region at which an event occurrence takes place. Optional, but required for a physical event and omitted for a purely digital event, and repeatable to provide parallel names for a single location in multiple languages (eg Baile Átha Cliath and Dublin, or Bruxelles and Brussel). It may if necessary include a postal code (eg 10680 Αθήνα, or 20090 Assago). The language attribute is optional for a single instance of <LocationName>, but must be included in each instance if <LocationName> is repeated.

      JONIX adds: this list may be empty

    • venueNotes

      public ListOfOnixElement<VenueNote,String> venueNotes()

      Free text of a short note related to the venue. Optional, and repeatable to provide parallel notes in multiple languages. The language attribute is optional for a single instance of <VenueNote>, but must be included in each instance if <VenueNote> is repeated.

      JONIX adds: this list may be empty

    • eventDescriptions

      public ListOfOnixElement<EventDescription,String> eventDescriptions()

      Free text describing the promotional event occurrence. Optional, and repeatable to provide parallel text 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 adds: this list may be empty

    • supportingResources

      public ListOfOnixComposite<SupportingResource> supportingResources()

      An optional group of data elements which together describe a supporting resource related to an occurrence of 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 adds: 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 occurrence. 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 adds: 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 occurrence – for example a website providing a ticketing service. Repeatable to provide links to multiple websites.

      JONIX adds: this list may be empty