Module jonix.onix3

Package com.tectonica.jonix.onix3

Class ProductAvailability

java.lang.Object

com.tectonica.jonix.onix3.ProductAvailability

All Implemented Interfaces:

OnixElement<ProductAvailabilitys>, OnixTag, Serializable

public class ProductAvailability
extends Object
implements OnixElement<ProductAvailabilitys>, Serializable

Product availability

An ONIX code indicating the availability of a product from a supplier. Mandatory in each occurrence of the <SupplyDetail> composite, and non-repeating.

Format	Fixed length, two digits
Codelist	List 65
Reference name	<ProductAvailability>
Short tag	<j396>
Cardinality	1
Example	<j396 datestamp="20101029">41</j396> (Replaced by new product)
Notes	Note the typical progression of product availability, from initial announcement to one of the forms of 'unavailable'. Not all possible availability codes are shown, particularly within the 'Unavailable' group where there are many more possible options: Temporarily unavailable (3x codes) Available (2x codes) Available (2x codes) Unavailable (4x, 5x codes) OTO (22) POD (23) INS (21) AWS (11) [stock on order] [stock on order] [will not be stock item] ['published', no stock yet] ['published', no stock yet] [publisher abandons] NYA (10) AB (01) [stock in warehouse] NYAD (12) ['publish'] ['publish'] RI (33) RP (32) OS (31) [publisher abandons] RPL (41) NLS (43) ALT (42) [POD product] ['Stock' product] Transitions within and between the shaded groups are greatly simplified - for example, it would be unexpected if 'Reprinting' or 'Reissuing' statuses (32 and 33 on List 65) would be followed by anything other than 'In stock' (21), but on occasion where the publisher changes plans, 'Available via POD' (23), 'Only to order' (22), or an 'Unavailable' (4x) code are all possible. Ideally, 'Abandoned' (01) and the 'Unavailable' (4x) codes indicate the end of the product's life, but as with <PublishingStatus>, cancelled or out of print products are occasionally re-activated or re-announced.

This tag may be included in the following composites:

• <SupplyDetail>

Possible placements within ONIX message:

• Product ⯈ ProductSupply ⯈ SupplyDetail ⯈ ProductAvailability

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ProductAvailability()
ProductAvailability(Element element)

Method Summary

Modifier and Type	Method	Description
ProductAvailabilitys	__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<ProductAvailability> 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 ProductAvailabilitys value

EMPTY

public static final ProductAvailability EMPTY

Constructor Details

ProductAvailability

public ProductAvailability()

ProductAvailability

public ProductAvailability(Element element)

Method Details

__v

public ProductAvailabilitys __v()

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

Specified by:

__v in interface OnixElement<ProductAvailabilitys>

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

ifExists

public void ifExists(Consumer<ProductAvailability> action)

codeOrNull

public String codeOrNull()

descriptionOrNull

public String descriptionOrNull()