Module jonix.onix2

Package com.tectonica.jonix.onix2

Class AvailabilityCode

java.lang.Object

com.tectonica.jonix.onix2.AvailabilityCode

All Implemented Interfaces:

OnixElement<AvailabilityStatuss>, OnixTag, Serializable

public class AvailabilityCode
extends Object
implements OnixElement<AvailabilityStatuss>, Serializable

Availability status code

An ONIX code indicating the availability of a product. Each occurrence of the <SupplyDetail> composite must carry either <AvailabilityCode> or <ProductAvailability>, or both, but <ProductAvailability> is now strongly preferred. Non-repeating.

Some code values require other accompanying data. Where the code lists state that one of the following is required or may optionally be sent, use the element indicated below:

• Expected availability date – use <ExpectedShipDate>
• Remainder date – <ExpectedShipDate> is again used
• Estimated time to supply – <OrderTime>
• Identifier of alternative or successor product – <RelatedProduct>, Group PR.23
• New supplier – <NewSupplier>

Format	Fixed-length, two letters
Codelist	List 54
Reference name	<AvailabilityCode>
Short tag	<j141>
Example	<AvailabilityCode>OP</AvailabilityCode> Out of print

This tag may be included in the following composites:

• <SupplyDetail>

Possible placements within ONIX message:

• Product ⯈ SupplyDetail ⯈ AvailabilityCode

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: DateOrDateTime)
static final AvailabilityCode	EMPTY
Languages	language
static final String	refname
static final String	shortname
String	sourcename
RecordSourceTypes	sourcetype
TextCaseFlags	textcase
TextFormats	textformat
TransliterationSchemes	transliteration
AvailabilityStatuss	value

Constructor Summary

Constructors

Constructor	Description
AvailabilityCode()
AvailabilityCode(Element element)

Method Summary

Modifier and Type	Method	Description
AvailabilityStatuss	__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<AvailabilityCode> 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

textformat

public TextFormats textformat

textcase

public TextCaseFlags textcase

language

public Languages language

transliteration

public TransliterationSchemes transliteration

datestamp

public String datestamp

(type: DateOrDateTime)

sourcetype

public RecordSourceTypes sourcetype

sourcename

public String sourcename

value

public AvailabilityStatuss value

EMPTY

public static final AvailabilityCode EMPTY

Constructor Details

AvailabilityCode

public AvailabilityCode()

AvailabilityCode

public AvailabilityCode(Element element)

Method Details

__v

public AvailabilityStatuss __v()

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

Specified by:

__v in interface OnixElement<AvailabilityStatuss>

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

ifExists

public void ifExists(Consumer<AvailabilityCode> action)

codeOrNull

public String codeOrNull()

descriptionOrNull

public String descriptionOrNull()