- All Implemented Interfaces:
OnixComposite
,OnixComposite.OnixSuperComposite
,OnixTag
,Serializable
Supporting resource composite
An optional group of data elements which together describe a supporting resource. The composite is repeatable to describe and link to multiple resources. Note that different forms of the same resource (for example a cover image in separate low and high resolution versions) should be specified in a single instance of the composite.
Reference name | <SupportingResource> |
Short tag | <supportingresource> |
Cardinality | 0…n |
- See Also:
-
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
Modifier and TypeFieldDescription(type: dt.DateOrDateTime)static final SupportingResource
static final String
static final String
(type: dt.NonEmptyString) -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
This is an internal API.An ONIX code which identifies the audience for which the supporting resource is intended.boolean
exists()
indicates whether this tag exists in the ONIX recordFor advanced use-cases only.void
ifExists
(Consumer<SupportingResource> action) An ONIX code indicating the type of content carried in a supporting resource.A group of data elements which together describe a feature of a supporting resource which is common to all versions in which the resource is offered.An ONIX code indicating the mode of the supporting resource, eg audio, video.A group of data elements which together describe a single version of a supporting resource, for example a particular format of a cover image.A number which specifies a single overall sequence of supporting resources.A group of data elements which together define a territory for which the supporting resource is specifically intended.
-
Field Details
-
refname
- See Also:
-
shortname
- See Also:
-
datestamp
(type: dt.DateOrDateTime) -
sourcename
(type: dt.NonEmptyString) -
sourcetype
-
EMPTY
-
-
Constructor Details
-
SupportingResource
public SupportingResource() -
SupportingResource
-
-
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 interfaceOnixComposite
-
exists
public boolean exists()Description copied from interface:OnixTag
indicates whether this tag exists in the ONIX record -
ifExists
-
getXmlElement
Description copied from interface:OnixComposite
For advanced use-cases only.- Specified by:
getXmlElement
in interfaceOnixComposite
- Returns:
- native representation of the XML element underlying to this tag
-
resourceContentType
An ONIX code indicating the type of content carried in a supporting resource. Mandatory in each occurrence of the <SupportingResource> composite, and non-repeating.
Jonix-Comment: this field is required -
resourceMode
An ONIX code indicating the mode of the supporting resource, eg audio, video. Mandatory in each occurrence of the <SupportingResource> composite, and non-repeating.
Jonix-Comment: this field is required -
contentAudiences
An ONIX code which identifies the audience for which the supporting resource is intended. Mandatory in each occurrence of the <SupportingResource> composite, and repeatable.
Jonix-Comment: this list is required to contain at least one item -
resourceVersions
A group of data elements which together describe a single version of a supporting resource, for example a particular format of a cover image. At least one instance is mandatory in each occurrence of the <SupportingResource> composite, and the composite should be repeated as necessary if the resource is offered in multiple versions.
Jonix-Comment: this list is required to contain at least one item -
sequenceNumber
A number which specifies a single overall sequence of supporting resources. Optional and non-repeating. It is strongly recommended that if any occurrence of the <SupportingResource> composite of a specific <ResourceContentType> carries a <SequenceNumber>, then all of that type should carry a <SequenceNumber> – though there is no requirement to number supporting resources where there is a single instance of that type.
Jonix-Comment: this field is optional -
territory
A group of data elements which together define a territory for which the supporting resource is specifically intended. Optional in each occurrence of the <SupportingResource> composite, and non-repeating. If omitted, the supporting resource is intended for use wherever the product may be sold (see Territorial sales rights in Group P.21). If included, the resource should be used by recipients in the specified territory only, and in preference to any supporting resource that lacks a specified territory.
For valid combinations of <CountriesIncluded>, <RegionsIncluded> etc within <Territory>, see the notes describing the use of <Territory> within Group P.21.
Care should be taken to avoid ambiguities (for example two different cover images marked for use in the same country or region), and to ensure that appropriate resources are supplied for all countries and regions where the product may be sold. The simplest way to accomplish the latter is to ensure at least one version of the resource does not have a territory specified. Where multiple resources of the same type are provided, those without specific <Territory> composites are intended for use only where no appropriate targeted resource is present.
Jonix-Comment: this field is optional -
resourceFeatures
public ListOfOnixDataCompositeWithKey<ResourceFeature,JonixResourceFeature, resourceFeatures()ResourceFeatureTypes> A group of data elements which together describe a feature of a supporting resource which is common to all versions in which the resource is offered. Optional, and repeatable in order to describe multiple features of the resource.
Jonix-Comment: this list may be empty
-