Module jonix.onix3

Package com.tectonica.jonix.onix3

Class EpubLicenseDate

java.lang.Object

com.tectonica.jonix.onix3.EpubLicenseDate

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixDataComposite<JonixEpubLicenseDate>, OnixComposite.OnixDataCompositeWithKey<JonixEpubLicenseDate,EpublicationLicenseDateRoles>, OnixTag, Serializable

public class EpubLicenseDate
extends Object
implements OnixComposite.OnixDataCompositeWithKey<JonixEpubLicenseDate,EpublicationLicenseDateRoles>, Serializable

Digital product license date

An optional group of date elements which together specify a date associated with the license in an occurrence of the <EpubLicense> composite, eg a date when a license expires. Repeatable to specify different dates with their various roles.

Note that if no dates are specified, the license is effective at the time the ONIX message is sent.

Reference name	<EpubLicenseDate>
Short tag	<epublicensedate>
Cardinality	0…n

This tag may be included in the following composites:

• <EpubLicenseWithDateType>

Possible placements within ONIX message:

• Product ⯈ DescriptiveDetail ⯈ EpubLicenseWithDateType ⯈ EpubLicenseDate
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ EpubLicenseWithDateType ⯈ EpubLicenseDate
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ TextContent ⯈ EpubLicenseWithDateType ⯈ EpubLicenseDate
• Product ⯈ CollateralDetail ⯈ TextContent ⯈ EpubLicenseWithDateType ⯈ EpubLicenseDate
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ SupportingResource ⯈ ResourceVersion ⯈ EpubLicenseWithDateType ⯈ EpubLicenseDate
• Product ⯈ CollateralDetail ⯈ SupportingResource ⯈ ResourceVersion ⯈ EpubLicenseWithDateType ⯈ EpubLicenseDate
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ EventOccurrence ⯈ SupportingResource ⯈ ResourceVersion ⯈ EpubLicenseWithDateType ⯈ EpubLicenseDate
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ SupportingResource ⯈ ResourceVersion ⯈ EpubLicenseWithDateType ⯈ EpubLicenseDate

Since:

Onix-3.10

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 EpubLicenseDate	EMPTY
static final String	refname
static final String	shortname
String	sourcename	(type: dt.NonEmptyString)
RecordSourceTypes	sourcetype

Constructor Summary

Constructors

Constructor	Description
EpubLicenseDate()
EpubLicenseDate(Element element)

Method Summary

Modifier and Type	Method	Description
void	_initialize()	This is an internal API.
JonixEpubLicenseDate	asStruct()
Date	date()	The date specified in the <EpubLicenseDateRole> field.
EpubLicenseDateRole	epubLicenseDateRole()	An ONIX code indicating the significance of the date in relation to the license.
boolean	exists()	indicates whether this tag exists in the ONIX record
Element	getXmlElement()	For advanced use-cases only.
void	ifExists(Consumer<EpubLicenseDate> action)
EpublicationLicenseDateRoles	structKey()

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 EpubLicenseDate EMPTY

Constructor Details

EpubLicenseDate

public EpubLicenseDate()

EpubLicenseDate

public EpubLicenseDate(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 (<EpubLicenseDate> or <epublicensedate>) is explicitly provided in the ONIX XML

ifExists

public void ifExists(Consumer<EpubLicenseDate> 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

epubLicenseDateRole

public EpubLicenseDateRole epubLicenseDateRole()

An ONIX code indicating the significance of the date in relation to the license. Mandatory in each occurrence of the <EpubLicenseDate> composite, and non-repeating.

Jonix-Comment: this field is required

date

public Date date()

The date specified in the <EpubLicenseDateRole> field. Mandatory in each occurrence of the <EpubLicenseDate> composite, and non-repeating. <Date> may carry a dateformat attribute: if the attribute is missing, then the default format is YYYYMMDD.

Jonix-Comment: this field is required

asStruct

public JonixEpubLicenseDate asStruct()

Specified by:

asStruct in interface OnixComposite.OnixDataComposite<JonixEpubLicenseDate>

structKey

public EpublicationLicenseDateRoles structKey()

Specified by:

structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixEpubLicenseDate,EpublicationLicenseDateRoles>