Module jonix.onix3

Package com.tectonica.jonix.onix3

Class ResourceRole

java.lang.Object

com.tectonica.jonix.onix3.ResourceRole

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

public class ResourceRole
extends Object
implements OnixElement<String>, Serializable

Resource role code

An ONIX code which identifies the role or purpose of the resource file which is specified in <ResourceFileLink>. Optional and non-repeating, and may only be used when <ResourceFileLink> is present.

Format	Fixed length, three characters: one letter followed by two digits
Codelist	List 251
Reference name	<ResourceRole>
Short tag	<x566>
Cardinality	0…1
Example	<ResourceRole>01</ResourceRole>

This tag may be included in the following composites:

• <CoverResource>
• <BodyResource>
• <InsertResource>

Possible placements within ONIX message:

• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ SupplementManifest ⯈ CoverManifest ⯈ CoverResource ⯈ ResourceRole
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ CoverManifest ⯈ CoverResource ⯈ ResourceRole
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ SupplementManifest ⯈ BodyManifest ⯈ BodyResource ⯈ ResourceRole
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ BodyManifest ⯈ BodyResource ⯈ ResourceRole
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ SupplementManifest ⯈ InsertManifest ⯈ InsertResource ⯈ ResourceRole
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ InsertManifest ⯈ InsertResource ⯈ ResourceRole

Since:

Onix-3.08

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: dt.DateOrDateTime)
static final ResourceRole	EMPTY
static final String	refname
static final String	shortname
String	sourcename	(type: dt.NonEmptyString)
RecordSourceTypes	sourcetype
String	value	This is the raw content of ResourceRole.

Constructor Summary

Constructors

Constructor	Description
ResourceRole()
ResourceRole(Element element)

Method Summary

Modifier and Type	Method	Description
String	__v()	Internal API, use the OnixElement.value() method or the OnixElement.value() field instead
boolean	exists()	indicates whether this tag exists in the ONIX record
void	ifExists(Consumer<ResourceRole> 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 String value

This is the raw content of ResourceRole. Could be null if exists() == false. Use OnixElement.value() instead if you want to get this as an Optional.

Raw Format: Fixed length, three characters: one letter followed by two digits

(type: List251)

EMPTY

public static final ResourceRole EMPTY

Constructor Details

ResourceRole

public ResourceRole()

ResourceRole

public ResourceRole(Element element)

Method Details

__v

public String __v()

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

Specified by:

__v in interface OnixElement<String>

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

ifExists

public void ifExists(Consumer<ResourceRole> action)