Module jonix.onix3

Package com.tectonica.jonix.onix3

Class MarketReference

java.lang.Object

com.tectonica.jonix.onix3.MarketReference

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

public class MarketReference
extends Object
implements OnixElement<String>, Serializable

Market reference

For every market, a single market reference which will uniquely identify the <ProductSupply> composite which describes the market within this Product record, and which will remain as its permanent identifier every time you send an update.

The Market reference is optional and non-repeating, but it is strongly recommended unless there is only a single market. It is intended to be used to label each repeat of <ProductSupply> for use in subsequent partial updates and reporting.

Note that the scope of the Market reference is limited to a single Product record – a geographically identical market for a different product may have a different Market reference, and a geographically different market in another Product record may use the same reference.

Format	Variable length alphanumeric, suggested maximum length 100 characters
Reference name	<MarketReference>
Short tag	<x587>
Cardinality	0…1
Example	<x587>jp.kadokawa.onix.market.アジア太平洋1</x587> (Asia-Pacific 1)

This tag may be included in the following composites:

• <ProductSupply>

Possible placements within ONIX message:

• Product ⯈ ProductSupply ⯈ MarketReference

Since:

Onix-3.10

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: dt.DateOrDateTime)
static final MarketReference	EMPTY
static final String	refname
static final String	shortname
String	sourcename	(type: dt.NonEmptyString)
RecordSourceTypes	sourcetype
String	value	This is the raw content of MarketReference.

Constructor Summary

Constructors

Constructor	Description
MarketReference()
MarketReference(Element element)

Method Summary

Modifier and Type	Method	Description
String	__v()	Internal API, use the OnixElement.value() method or the OnixElement.value() field instead
boolean	exists()	indicates whether this tag exists in the ONIX record
void	ifExists(Consumer<MarketReference> 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 String value

This is the raw content of MarketReference. Could be null if exists() == false. Use OnixElement.value() instead if you want to get this as an Optional.

Raw Format: Variable length alphanumeric, suggested maximum length 100 characters

(type: dt.NonEmptyString)

EMPTY

public static final MarketReference EMPTY

Constructor Details

MarketReference

public MarketReference()

MarketReference

public MarketReference(Element element)

Method Details

__v

public String __v()

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

Specified by:

__v in interface OnixElement<String>

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

ifExists

public void ifExists(Consumer<MarketReference> action)