Module jonix.onix3

Package com.tectonica.jonix.onix3

Class CollectionFrequency

java.lang.Object

com.tectonica.jonix.onix3.CollectionFrequency

All Implemented Interfaces:

OnixElement<CollectionFrequencys>, OnixTag, Serializable

public class CollectionFrequency
extends Object
implements OnixElement<CollectionFrequencys>, Serializable

Collection frequency

An ONIX code specifying the approximate or expected publication frequency for addition of new products to the collection. Optional, and non-repeating.

Format	Fixed-length text, one alphabetic character
Codelist	List 259
Reference name	<CollectionFrequency>
Short tag	<x582>
Cardinality	1
Example	<x582>q</x582> (Four times per year)

This tag may be included in the following composites:

• <Collection>

Possible placements within ONIX message:

• Product ⯈ DescriptiveDetail ⯈ Collection ⯈ CollectionFrequency

Since:

Onix-3.10

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
CollectionFrequency()
CollectionFrequency(Element element)

Method Summary

Modifier and Type	Method	Description
CollectionFrequencys	__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<CollectionFrequency> 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 CollectionFrequencys value

EMPTY

public static final CollectionFrequency EMPTY

Constructor Details

CollectionFrequency

public CollectionFrequency()

CollectionFrequency

public CollectionFrequency(Element element)

Method Details

__v

public CollectionFrequencys __v()

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

Specified by:

__v in interface OnixElement<CollectionFrequencys>

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

ifExists

public void ifExists(Consumer<CollectionFrequency> action)

codeOrNull

public String codeOrNull()

descriptionOrNull

public String descriptionOrNull()