Module jonix.onix2

Package com.tectonica.jonix.onix2

Class RelationCode

java.lang.Object

com.tectonica.jonix.onix2.RelationCode

All Implemented Interfaces:

OnixElement<ProductRelations>, OnixTag, Serializable

public class RelationCode
extends Object
implements OnixElement<ProductRelations>, Serializable

Relation code

An ONIX code which identifies the nature of the relationship between two products, eg “replaced-by”. Mandatory in each occurrence of the <RelatedProduct> composite, and non-repeating.

Format	Fixed length, two numeric digits
Codelist	List 51
Reference name	<RelationCode>
Short tag	<h208>
Example	<RelationCode>06</RelationCode> Alternative format

This tag may be included in the following composites:

• <RelatedProduct>

Possible placements within ONIX message:

• Product ⯈ RelatedProduct ⯈ RelationCode

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
RelationCode()
RelationCode(Element element)

Method Summary

Modifier and Type	Method	Description
ProductRelations	__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<RelationCode> 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 ProductRelations value

EMPTY

public static final RelationCode EMPTY

Constructor Details

RelationCode

public RelationCode()

RelationCode

public RelationCode(Element element)

Method Details

__v

public ProductRelations __v()

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

Specified by:

__v in interface OnixElement<ProductRelations>

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

ifExists

public void ifExists(Consumer<RelationCode> action)

codeOrNull

public String codeOrNull()

descriptionOrNull

public String descriptionOrNull()