Module jonix.onix3

Package com.tectonica.jonix.onix3

Class OnHand

java.lang.Object

com.tectonica.jonix.onix3.OnHand

All Implemented Interfaces:

OnixElement<Integer>, OnixTag, Serializable

public class OnHand
extends Object
implements OnixElement<Integer>, Serializable

Quantity on hand

The quantity of stock on hand and available to fulfill new orders. Either <StockQuantityCoded> or <OnHand> is mandatory in each occurrence of the <Stock> composite, even if the quantity on hand is zero. Non-repeating.

Format	Positive or negative integer or zero, suggested maximum length 7 digits. Negative numbers indicate order commitments in excess of the copies on hand for which no further stock has been ordered
Reference name	<OnHand>
Short tag	<j350>
Cardinality	0…1
Example	<OnHand>4259</OnHand>

This tag may be included in the following composites:

• <Stock>

Possible placements within ONIX message:

• Product ⯈ ProductSupply ⯈ SupplyDetail ⯈ Stock ⯈ OnHand

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
OnHand()
OnHand(Element element)

Method Summary

Modifier and Type	Method	Description
Integer	__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<OnHand> 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 Integer value

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

Raw Format: Positive or negative integer or zero, suggested maximum length 7 digits. Negative numbers indicate order commitments in excess of the copies on hand for which no further stock has been ordered

(type: dt.Integer)

EMPTY

public static final OnHand EMPTY

Constructor Details

OnHand

public OnHand()

OnHand

public OnHand(Element element)

Method Details

__v

public Integer __v()

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

Specified by:

__v in interface OnixElement<Integer>

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

ifExists

public void ifExists(Consumer<OnHand> action)