Module jonix.onix3

Package com.tectonica.jonix.onix3

Class EpubUsageStatus

java.lang.Object

com.tectonica.jonix.onix3.EpubUsageStatus

All Implemented Interfaces:

OnixElement<UsageStatuss>, OnixTag, Serializable

public class EpubUsageStatus
extends Object
implements OnixElement<UsageStatuss>, Serializable

Usage status (digital products)

An ONIX code specifying the status of a usage of a digital product, eg permitted without limit, permitted with limit, prohibited. Mandatory in each occurrence of the <EpubUsageConstraint> composite, and non-repeating.

Format	Fixed length, two digits
Codelist	List 146
Reference name	<EpubUsageStatus>
Short tag	<x319>
Cardinality	1
Example	<x319>03</x318> (Prohibited)

This tag may be included in the following composites:

• <EpubUsageConstraint>

Possible placements within ONIX message:

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

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
EpubUsageStatus()
EpubUsageStatus(Element element)

Method Summary

Modifier and Type	Method	Description
UsageStatuss	__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<EpubUsageStatus> 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 UsageStatuss value

EMPTY

public static final EpubUsageStatus EMPTY

Constructor Details

EpubUsageStatus

public EpubUsageStatus()

EpubUsageStatus

public EpubUsageStatus(Element element)

Method Details

__v

public UsageStatuss __v()

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

Specified by:

__v in interface OnixElement<UsageStatuss>

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

ifExists

public void ifExists(Consumer<EpubUsageStatus> action)

codeOrNull

public String codeOrNull()

descriptionOrNull

public String descriptionOrNull()