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

Class OccurrenceDate

java.lang.Object
com.tectonica.jonix.onix3.OccurrenceDate
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixDataComposite<JonixOccurrenceDate>, OnixComposite.OnixDataCompositeWithKey<JonixOccurrenceDate,EventOccurrenceDateRoles>, OnixTag, Serializable
public class OccurrenceDate extends Object implements OnixComposite.OnixDataCompositeWithKey<JonixOccurrenceDate,EventOccurrenceDateRoles>, Serializable

Event occurrence date composite

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.

Reference name <OccurrenceDate>
Short tag <occurrencedate>
Cardinality 1…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

    • OccurrenceDate

      public OccurrenceDate()

    • OccurrenceDate

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

    • ifExists

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

    • occurrenceDateRole

      public OccurrenceDateRole occurrenceDateRole()

      An ONIX code indicating the significance of the date, eg the date of the occurrence, last date of ticket availability etc. Mandatory in each instance of the <OccurrenceDate> composite, and non-repeating.

      Jonix-Comment: this field is required

    • date

      public Date date()

      The date specified in the <OccurrenceDateRole> field. Mandatory in each occurrence of the <OccurrenceDate> composite, and non-repeating. <Date> may carry a dateformat attribute: if the attribute is missing, then the default format is YYYYMMDDThhmm (local time at the venue). Note that this date format may include a time zone offset (Z for times in UTC, or ±hhmm), and this should always be included where there is any doubt, eg when the event is available online.

      Jonix-Comment: this field is required

    • asStruct

      public JonixOccurrenceDate asStruct()
      Specified by:
      asStruct in interface OnixComposite.OnixDataComposite<JonixOccurrenceDate>

    • structKey

      public EventOccurrenceDateRoles structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixOccurrenceDate,EventOccurrenceDateRoles>