Module jonix.onix3

Package com.tectonica.jonix.onix3

Class InsertResource

java.lang.Object

com.tectonica.jonix.onix3.InsertResource

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixSuperComposite, OnixTag, Serializable

public class InsertResource
extends Object
implements OnixComposite.OnixSuperComposite, Serializable

Insert resource composite

A group of data elements that together provide details of a single file or resource of which the insert is composed. At least one <InsertResource> composite is required in each <InsertManifest>, and the <InsertResource> composite is repeatable to describe multiple resources.

The composite must contain either a Resource file link or a No resource indicator.

Reference name	<InsertResource>
Short tag	<insertresource>
Cardinality	1…n

This tag may be included in the following composites:

• <InsertManifest>

Possible placements within ONIX message:

• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ SupplementManifest ⯈ InsertManifest ⯈ InsertResource
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ InsertManifest ⯈ InsertResource

Since:

Onix-3.08

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

Constructor Summary

Constructors

Constructor	Description
InsertResource()
InsertResource(Element element)

Method Summary

Modifier and Type	Method	Description
void	_initialize()	This is an internal API.
boolean	exists()	indicates whether this tag exists in the ONIX record
Element	getXmlElement()	For advanced use-cases only.
void	ifExists(Consumer<InsertResource> action)
boolean	isNoResource()
NoResource	noResource()	An empty element that provides a positive indication that there is no alternative ‘generic’ resource to be used in cases where there is a vendor-specific resource (indicated using <SalesOutlet>) with the same <SequenceNumber> specified within the manifest.
ListOfOnixElement<ResourceFileContentDescription,String>	resourceFileContentDescriptions()	Jonix-Comment: this list may be empty
ListOfOnixDataCompositeWithKey<ResourceFileDate,JonixResourceFileDate,ResourceFileDateRoles>	resourceFileDates()	Jonix-Comment: this list may be empty
ListOfOnixElement<ResourceFileDescription,String>	resourceFileDescriptions()	Jonix-Comment: this list may be empty
ListOfOnixCodelist<ResourceFileDetail,ResourceFileDetails>	resourceFileDetails()	Jonix-Comment: this list may be empty
ListOfOnixDataCompositeWithKey<ResourceFileFeature,JonixResourceFileFeature,ResourceFileFeatureTypes>	resourceFileFeatures()	Jonix-Comment: this list may be empty
ListOfOnixElement<ResourceFileLink,String>	resourceFileLinks()	Jonix-Comment: this list is required to contain at least one item
ListOfOnixDataCompositeWithKey<ResourceIdentifier,JonixResourceIdentifier,ResourceIdentifierTypes>	resourceIdentifiers()	Jonix-Comment: this list may be empty
ResourceRole	resourceRole()	Jonix-Comment: this field is optional
ListOfOnixComposite<SalesOutlet>	salesOutlets()	Jonix-Comment: this list may be empty
SequenceNumber	sequenceNumber()	Jonix-Comment: this field is optional

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

Constructor Details

InsertResource

public InsertResource()

InsertResource

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

ifExists

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

resourceFileLinks

public ListOfOnixElement<ResourceFileLink,String> resourceFileLinks()

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

sequenceNumber

public SequenceNumber sequenceNumber()

Jonix-Comment: this field is optional

resourceRole

public ResourceRole resourceRole()

Jonix-Comment: this field is optional

noResource

public NoResource noResource()

An empty element that provides a positive indication that there is no alternative ‘generic’ resource to be used in cases where there is a vendor-specific resource (indicated using <SalesOutlet>) with the same <SequenceNumber> specified within the manifest. The empty <NoResource/> must be used – and must only be used – when no <ResourceFileLink> is present.

Jonix-Comment: this field is optional

isNoResource

public boolean isNoResource()

salesOutlets

public ListOfOnixComposite<SalesOutlet> salesOutlets()

Jonix-Comment: this list may be empty

resourceIdentifiers

public ListOfOnixDataCompositeWithKey<ResourceIdentifier,JonixResourceIdentifier,ResourceIdentifierTypes> resourceIdentifiers()

Jonix-Comment: this list may be empty

resourceFileDetails

public ListOfOnixCodelist<ResourceFileDetail,ResourceFileDetails> resourceFileDetails()

Jonix-Comment: this list may be empty

resourceFileFeatures

public ListOfOnixDataCompositeWithKey<ResourceFileFeature,JonixResourceFileFeature,ResourceFileFeatureTypes> resourceFileFeatures()

Jonix-Comment: this list may be empty

resourceFileDescriptions

public ListOfOnixElement<ResourceFileDescription,String> resourceFileDescriptions()

Jonix-Comment: this list may be empty

resourceFileContentDescriptions

public ListOfOnixElement<ResourceFileContentDescription,String> resourceFileContentDescriptions()

Jonix-Comment: this list may be empty

resourceFileDates

public ListOfOnixDataCompositeWithKey<ResourceFileDate,JonixResourceFileDate,ResourceFileDateRoles> resourceFileDates()

Jonix-Comment: this list may be empty