Module jonix.onix2

Package com.tectonica.jonix.onix2

Class ProductFormDescription

java.lang.Object

com.tectonica.jonix.onix2.ProductFormDescription

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

public class ProductFormDescription
extends Object
implements OnixElement<String>, Serializable

Product form description

If product form codes do not adequately describe the product, a short text description may be added to give a more detailed specification of the product form. The field is optional and non-repeating. Although this element was originally included to allow the number and type of pieces contained in a multiple product to be stated, as in the example below, the correct method of describing mixed media products in Release 2.1 is to use two or more occurrences of the <ContainedItem> composite to give a properly structured specification of each media type.

Format	Variable-length text, suggested maximum length 200 characters.
Reference name	<ProductFormDescription>
Short tag	<b014>
Example	<b014>3 volumes with 2 audiocassettes</b014>

This tag may be included in the following composites:

• <Product>
• <ContainedItem>
• <RelatedProduct>

Possible placements within ONIX message:

• Product ⯈ ProductFormDescription
• Product ⯈ ContainedItem ⯈ ProductFormDescription
• Product ⯈ RelatedProduct ⯈ ProductFormDescription

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: DateOrDateTime)
static final ProductFormDescription	EMPTY
Languages	language
static final String	refname
static final String	shortname
String	sourcename
RecordSourceTypes	sourcetype
TextCaseFlags	textcase
TextFormats	textformat
TransliterationSchemes	transliteration
String	value	This is the raw content of ProductFormDescription.

Constructor Summary

Constructors

Constructor	Description
ProductFormDescription()
ProductFormDescription(Element element)

Method Summary

Modifier and Type	Method	Description
String	__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<ProductFormDescription> 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 String value

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

Raw Format: Variable-length text, suggested maximum length 200 characters.

(type: NonEmptyString)

EMPTY

public static final ProductFormDescription EMPTY

Constructor Details

ProductFormDescription

public ProductFormDescription()

ProductFormDescription

public ProductFormDescription(Element element)

Method Details

__v

public String __v()

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

Specified by:

__v in interface OnixElement<String>

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

ifExists

public void ifExists(Consumer<ProductFormDescription> action)