Module jonix.onix3

Package com.tectonica.jonix.onix3

Class EpubUsageLimit

java.lang.Object

com.tectonica.jonix.onix3.EpubUsageLimit

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixDataComposite<JonixEpubUsageLimit>, OnixTag, Serializable

public class EpubUsageLimit
extends Object
implements OnixComposite.OnixDataComposite<JonixEpubUsageLimit>, Serializable

Usage limit composite (digital products)

An optional group of data elements which together specify a quantitative limit on a particular type of usage of a digital product. Repeatable in order to specify two or more limits on the usage type.

Reference name	<EpubUsageLimit>
Short tag	<epubusagelimit>
Cardinality	0…n

This tag may be included in the following composites:

• <EpubUsageConstraint>

Possible placements within ONIX message:

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

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.tectonica.jonix.common.OnixComposite

OnixComposite.OnixDataComposite<V extends JonixStruct>, OnixComposite.OnixDataCompositeUncommon, OnixComposite.OnixDataCompositeWithKey<V extends JonixKeyedStruct<K>,K extends Enum<K> & OnixCodelist>, OnixComposite.OnixSuperComposite

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
EpubUsageLimit()
EpubUsageLimit(Element element)

Method Summary

Modifier and Type	Method	Description
void	_initialize()	This is an internal API.
JonixEpubUsageLimit	asStruct()
EpubUsageUnit	epubUsageUnit()	An ONIX code for a unit in which a permitted usage quantity is stated.
boolean	exists()	indicates whether this tag exists in the ONIX record
Element	getXmlElement()	For advanced use-cases only.
void	ifExists(Consumer<EpubUsageLimit> action)
Quantity	quantity()	A numeric value representing the maximum permitted quantity of a particular type of usage.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

EMPTY

public static final EpubUsageLimit EMPTY

Constructor Details

EpubUsageLimit

public EpubUsageLimit()

EpubUsageLimit

public EpubUsageLimit(Element element)

Method Details

_initialize

public void _initialize()

Description copied from interface: OnixComposite

This is an internal API. Since Jonix 8.0, composite objects are being populated lazily. This method initiates the population process, and is invoked internally by the accessor APIs of the composites

Specified by:

_initialize in interface OnixComposite

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

ifExists

public void ifExists(Consumer<EpubUsageLimit> action)

getXmlElement

public Element getXmlElement()

Description copied from interface: OnixComposite

For advanced use-cases only.

Specified by:

getXmlElement in interface OnixComposite

Returns:

native representation of the XML element underlying to this tag

quantity

public Quantity quantity()

A numeric value representing the maximum permitted quantity of a particular type of usage. Mandatory in each occurrence of the <EpubUsageLimit> composite, and non-repeating.

Jonix-Comment: this field is required

epubUsageUnit

public EpubUsageUnit epubUsageUnit()

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.

Jonix-Comment: this field is required

asStruct

public JonixEpubUsageLimit asStruct()

Specified by:

asStruct in interface OnixComposite.OnixDataComposite<JonixEpubUsageLimit>