Module jonix.onix3

Package com.tectonica.jonix.onix3

Class CopyrightStatement

java.lang.Object

com.tectonica.jonix.onix3.CopyrightStatement

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixSuperComposite, OnixTag, Serializable

public class CopyrightStatement
extends Object
implements OnixComposite.OnixSuperComposite, Serializable

Copyright statement composite (content item)

An optional and repeatable group of data elements which together represent a copyright or neighboring right statement for the content item. At least one <CopyrightYear> or one instance of the <CopyrightOwner> composite must be sent within an instance of the composite, but it is recommended that all elements in the composite are explicitly populated. The Copyright statement may be repeated to provide a full structured rights statement listing year(s) and rights holder(s).

Reference name	<CopyrightStatement>
Short tag	<copyrightstatement>
Cardinality	0…n

This tag may be included in the following composites:

• <ContentItem>
• <PublishingDetail>

Possible placements within ONIX message:

• Product ⯈ ContentDetail ⯈ ContentItem ⯈ CopyrightStatement
• Product ⯈ PublishingDetail ⯈ CopyrightStatement

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

Constructor Summary

Constructors

Constructor	Description
CopyrightStatement()
CopyrightStatement(Element element)

Method Summary

Modifier and Type	Method	Description
void	_initialize()	This is an internal API.
ListOfOnixComposite<CopyrightOwner>	copyrightOwners()	A repeatable group of data elements which together name a copyright owner.
CopyrightType	copyrightType()	An optional ONIX code indicating the type of right covered by the statement, typically a copyright or neighboring right.
ListOfOnixElement<CopyrightYear,String>	copyrightYears()	The copyright year as it appears in a copyright statement on the product.
boolean	exists()	indicates whether this tag exists in the ONIX record
Element	getXmlElement()	For advanced use-cases only.
void	ifExists(Consumer<CopyrightStatement> action)

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

Constructor Details

CopyrightStatement

public CopyrightStatement()

CopyrightStatement

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

ifExists

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

copyrightYears

public ListOfOnixElement<CopyrightYear,String> copyrightYears()

The copyright year as it appears in a copyright statement on the product. Optional in each occurrence of the <CopyrightStatement> composite but may be omitted only if <CopyrightOwner> is present, and repeatable if several years or periods are listed.

Jonix-Comment: this list is required to contain at least one item

copyrightType

public CopyrightType copyrightType()

An optional ONIX code indicating the type of right covered by the statement, typically a copyright or neighboring right. If omitted, the default is that the statement represents a copyright.

Jonix-Comment: this field is optional

copyrightOwners

public ListOfOnixComposite<CopyrightOwner> copyrightOwners()

A repeatable group of data elements which together name a copyright owner. Optional, but may be omitted only if <CopyrightYear> is present. Each occurrence of the <CopyrightOwner> composite must carry a single name (personal or corporate), or an identifier, or both.

Jonix-Comment: this list may be empty