Module jonix.onix3

Package com.tectonica.jonix.onix3

Class EventStatus

java.lang.Object

com.tectonica.jonix.onix3.EventStatus

All Implemented Interfaces:

OnixElement<EventStatuss>, OnixTag, Serializable

public class EventStatus
extends Object
implements OnixElement<EventStatuss>, Serializable

Event status

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

Format	Fixed length, single character
Codelist	List 246
Reference name	<EventStatus>
Short tag	<x549>
Cardinality	0…1
Example	<EventStatus>A</EventStatus> (Announced)

This tag may be included in the following composites:

• <EventOccurrence>
• <PromotionalEvent>

Possible placements within ONIX message:

• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ EventOccurrence ⯈ EventStatus
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ EventStatus

Since:

Onix-3.07

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: dt.DateOrDateTime)
static final EventStatus	EMPTY
static final String	refname
static final String	shortname
String	sourcename	(type: dt.NonEmptyString)
RecordSourceTypes	sourcetype
EventStatuss	value

Constructor Summary

Constructors

Constructor	Description
EventStatus()
EventStatus(Element element)

Method Summary

Modifier and Type	Method	Description
EventStatuss	__v()	Internal API, use the OnixElement.value() method or the OnixElement.value() field instead
String	codeOrNull()
String	descriptionOrNull()
boolean	exists()	indicates whether this tag exists in the ONIX record
void	ifExists(Consumer<EventStatus> action)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.tectonica.jonix.common.OnixElement

equal, is, isNull, value

Field Details

refname

public static final String refname

See Also:

• Constant Field Values

shortname

public static final String shortname

See Also:

• Constant Field Values

datestamp

public String datestamp

(type: dt.DateOrDateTime)

sourcename

public String sourcename

(type: dt.NonEmptyString)

sourcetype

public RecordSourceTypes sourcetype

value

public EventStatuss value

EMPTY

public static final EventStatus EMPTY

Constructor Details

EventStatus

public EventStatus()

EventStatus

public EventStatus(Element element)

Method Details

__v

public EventStatuss __v()

Internal API, use the OnixElement.value() method or the OnixElement.value() field instead

Specified by:

__v in interface OnixElement<EventStatuss>

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 (<EventStatus> or <x549>) is explicitly provided in the ONIX XML

ifExists

public void ifExists(Consumer<EventStatus> action)

codeOrNull

public String codeOrNull()

descriptionOrNull

public String descriptionOrNull()