Module jonix.onix3

Package com.tectonica.jonix.onix3

Class PriceAmount

java.lang.Object

com.tectonica.jonix.onix3.PriceAmount

All Implemented Interfaces:

OnixElement<Double>, OnixTag, Serializable

public class PriceAmount
extends Object
implements OnixElement<Double>, Serializable

Price amount

The amount of a price. Optional and non-repeating, but each occurrence of the <Price> composite must include either a <PriceAmount> or a <PriceCoded> composite, with optional tax details, or an <UnpricedItemType> element. Note that free-of-charge products must use <UnpricedItemType> rather than a zero price.

Format	Positive real number, with explicit decimal point when required, suggested maximum length 12 characters
Reference name	<PriceAmount>
Short tag	<j151>
Cardinality	0…1
Example	<j151>18.99</j151>

This tag may be included in the following composites:

• <ComparisonProductPrice>
• <Price>

Possible placements within ONIX message:

• Product ⯈ ProductSupply ⯈ SupplyDetail ⯈ Price ⯈ ComparisonProductPrice ⯈ PriceAmount
• Product ⯈ ProductSupply ⯈ SupplyDetail ⯈ Price ⯈ PriceAmount

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
PriceAmount()
PriceAmount(Element element)

Method Summary

Modifier and Type	Method	Description
Double	__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<PriceAmount> 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 Double value

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

Raw Format: Positive real number, with explicit decimal point when required, suggested maximum length 12 characters

(type: dt.PositiveDecimal)

EMPTY

public static final PriceAmount EMPTY

Constructor Details

PriceAmount

public PriceAmount()

PriceAmount

public PriceAmount(Element element)

Method Details

__v

public Double __v()

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

Specified by:

__v in interface OnixElement<Double>

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

ifExists

public void ifExists(Consumer<PriceAmount> action)