Module jonix.onix3

Package com.tectonica.jonix.onix3

Class NumberOfCopies

java.lang.Object

com.tectonica.jonix.onix3.NumberOfCopies

All Implemented Interfaces:

OnixElement<Integer>, OnixTag, Serializable

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

Number of copies (product part)

When product parts are listed as a specified number of copies of a single item, usually identified by a <ProductIdentifier>, <NumberOfCopies> must be used to specify the quantity, even if the number is ‘1’. It must be used when a multiple-item product or pack contains (a) a quantity of a single item; or (b) one of each of several different items (as in a multi-volume set); or (c) one or more of each of several different items (as in a dumpbin carrying copies of two different books, or a classroom pack containing a teacher’s text and twenty student texts). Consequently the element is mandatory, and non-repeating, in an occurrence of the <ProductPart> composite if <NumberOfItemsOfThisForm> is not present. It is normally accompanied by a <ProductIdentifier>; but in exceptional circumstances, if the sender’s system is unable to provide an identifier at this level, it may be sent with product form coding and without an ID.

Format	Positive integer, suggested maximum length 4 digits
Reference name	<NumberOfCopies>
Short tag	<x323>
Cardinality	0…1
Example	<x323>24</x323> (24 copies of a single item in eg a classroom pack of textbooks)

This tag may be included in the following composites:

• <ProductPart>

Possible placements within ONIX message:

• Product ⯈ DescriptiveDetail ⯈ ProductPart ⯈ NumberOfCopies

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
NumberOfCopies()
NumberOfCopies(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<NumberOfCopies> 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 NumberOfCopies. Could be null if exists() == false. Use OnixElement.value() instead if you want to get this as an Optional.

Raw Format: Positive integer, suggested maximum length 4 digits

(type: dt.PositiveInteger)

EMPTY

public static final NumberOfCopies EMPTY

Constructor Details

NumberOfCopies

public NumberOfCopies()

NumberOfCopies

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

ifExists

public void ifExists(Consumer<NumberOfCopies> action)