Module jonix.onix3

Package com.tectonica.jonix.onix3

Class EpubUsageUnit

java.lang.Object

com.tectonica.jonix.onix3.EpubUsageUnit

All Implemented Interfaces:

OnixElement<UnitOfUsages>, OnixTag, Serializable

public class EpubUsageUnit
extends Object
implements OnixElement<UnitOfUsages>, Serializable

Usage unit (digital products)

An ONIX code for a unit in which a permitted usage quantity is stated. Mandatory in each occurrence of the <EpubUsageLimit> composite, and non-repeating.

Format	Fixed length, two digits
Codelist	List 147
Reference name	<EpubUsageUnit>
Short tag	<x321>
Cardinality	1
Example	<EpubUsageUnit>07</EpubUsageUnit> (Maximum number of concurrent users)

This tag may be included in the following composites:

• <EpubUsageLimit>

Possible placements within ONIX message:

• Product ⯈ DescriptiveDetail ⯈ EpubUsageConstraint ⯈ EpubUsageLimit ⯈ EpubUsageUnit
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ EpubUsageConstraint ⯈ EpubUsageLimit ⯈ EpubUsageUnit
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ TextContent ⯈ EpubUsageConstraint ⯈ EpubUsageLimit ⯈ EpubUsageUnit
• Product ⯈ CollateralDetail ⯈ TextContent ⯈ EpubUsageConstraint ⯈ EpubUsageLimit ⯈ EpubUsageUnit
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ SupportingResource ⯈ ResourceVersion ⯈ EpubUsageConstraint ⯈ EpubUsageLimit ⯈ EpubUsageUnit
• Product ⯈ CollateralDetail ⯈ SupportingResource ⯈ ResourceVersion ⯈ EpubUsageConstraint ⯈ EpubUsageLimit ⯈ EpubUsageUnit
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ EventOccurrence ⯈ SupportingResource ⯈ ResourceVersion ⯈ EpubUsageConstraint ⯈ EpubUsageLimit ⯈ EpubUsageUnit
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ SupportingResource ⯈ ResourceVersion ⯈ EpubUsageConstraint ⯈ EpubUsageLimit ⯈ EpubUsageUnit

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
EpubUsageUnit()
EpubUsageUnit(Element element)

Method Summary

Modifier and Type	Method	Description
UnitOfUsages	__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<EpubUsageUnit> 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 UnitOfUsages value

EMPTY

public static final EpubUsageUnit EMPTY

Constructor Details

EpubUsageUnit

public EpubUsageUnit()

EpubUsageUnit

public EpubUsageUnit(Element element)

Method Details

__v

public UnitOfUsages __v()

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

Specified by:

__v in interface OnixElement<UnitOfUsages>

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

ifExists

public void ifExists(Consumer<EpubUsageUnit> action)

codeOrNull

public String codeOrNull()

descriptionOrNull

public String descriptionOrNull()