Module jonix.onix3

Package com.tectonica.jonix.onix3

Class CurrencyCode

java.lang.Object

com.tectonica.jonix.onix3.CurrencyCode

All Implemented Interfaces:

OnixElement<CurrencyCodes>, OnixTag, Serializable

public class CurrencyCode
extends Object
implements OnixElement<CurrencyCodes>, Serializable

Currency code

An ONIX code identifying the currency in which all monetary amounts in an occurrence of the <Price> composite are stated. Optional and non-repeating, but required if the currency is not the default currency for the message (this default may be set in <DefaultCurrencyCode> – but doing so is deprecated). All ONIX messages must include an explicit statement of the currency used for any prices. To avoid any possible ambiguity, it is strongly recommended that the currency should be stated here for each individual price.

Format	Fixed length, three letters, based on ISO 4217. Note that ISO 4217 specifies that currency codes shall be sent as upper case only
Codelist	List 96
Reference name	<CurrencyCode>
Short tag	<j152>
Cardinality	0…1
Example	<j152>ZAR</j152> (South African Rand)

This tag may be included in the following composites:

• <ComparisonProductPrice>
• <Price>

Possible placements within ONIX message:

• Product ⯈ ProductSupply ⯈ SupplyDetail ⯈ Price ⯈ ComparisonProductPrice ⯈ CurrencyCode
• Product ⯈ ProductSupply ⯈ SupplyDetail ⯈ Price ⯈ CurrencyCode

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
CurrencyCode()
CurrencyCode(Element element)

Method Summary

Modifier and Type	Method	Description
CurrencyCodes	__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<CurrencyCode> 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 CurrencyCodes value

EMPTY

public static final CurrencyCode EMPTY

Constructor Details

CurrencyCode

public CurrencyCode()

CurrencyCode

public CurrencyCode(Element element)

Method Details

__v

public CurrencyCodes __v()

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

Specified by:

__v in interface OnixElement<CurrencyCodes>

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

ifExists

public void ifExists(Consumer<CurrencyCode> action)

codeOrNull

public String codeOrNull()

descriptionOrNull

public String descriptionOrNull()