Module jonix.onix3

Package com.tectonica.jonix.onix3

Class TaxAmount

java.lang.Object

com.tectonica.jonix.onix3.TaxAmount

All Implemented Interfaces:

OnixElement<Double>, OnixTag, Serializable

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

Tax amount

The amount of tax chargeable at the rate specified in an occurrence of the <Tax> composite. Optional and non-repeating; but either <TaxRatePercent> or <TaxAmount> or both must be present in each occurrence of the <Tax> composite.

Format	Positive real number, with explicit decimal point when required, or zero, suggested maximum length 12 characters
Reference name	<TaxAmount>
Short tag	<x474>
Cardinality	0…1
Example	<TaxAmount>1.86</TaxAmount>

This tag may be included in the following composites:

• <Tax>

Possible placements within ONIX message:

• Product ⯈ ProductSupply ⯈ SupplyDetail ⯈ Price ⯈ Tax ⯈ TaxAmount

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
TaxAmount()
TaxAmount(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<TaxAmount> 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 TaxAmount. 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, or zero, suggested maximum length 12 characters

(type: dt.PositiveDecimalOrZero)

EMPTY

public static final TaxAmount EMPTY

Constructor Details

TaxAmount

public TaxAmount()

TaxAmount

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

ifExists

public void ifExists(Consumer<TaxAmount> action)