Module jonix.onix3

Package com.tectonica.jonix.onix3

Class EpubUsageType

java.lang.Object

com.tectonica.jonix.onix3.EpubUsageType

All Implemented Interfaces:

OnixElement<UsageTypes>, OnixTag, Serializable

public class EpubUsageType
extends Object
implements OnixElement<UsageTypes>, Serializable

Usage type (digital products)

An ONIX code specifying a usage of a digital product. Mandatory in each occurrence of the <EpubUsageConstraint> composite, and non-repeating.

Format	Fixed length, two digits
Codelist	List 145
Reference name	<EpubUsageType>
Short tag	<x318>
Cardinality	1
Example	<x318>05</x318> (Text-to-speech)

Technical notes about <EpubUsageType> from the schema author: Particular type of usage of a digital product, eg text to speech, printing, lending This tag may be included in the following composites:

• <EpubUsageConstraint>

Possible placements within ONIX message:

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

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
EpubUsageType()
EpubUsageType(Element element)

Method Summary

Modifier and Type	Method	Description
UsageTypes	__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<EpubUsageType> 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 UsageTypes value

EMPTY

public static final EpubUsageType EMPTY

Constructor Details

EpubUsageType

public EpubUsageType()

EpubUsageType

public EpubUsageType(Element element)

Method Details

__v

public UsageTypes __v()

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

Specified by:

__v in interface OnixElement<UsageTypes>

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

ifExists

public void ifExists(Consumer<EpubUsageType> action)

codeOrNull

public String codeOrNull()

descriptionOrNull

public String descriptionOrNull()