Module jonix.onix3
Package com.tectonica.jonix.onix3

Class SupportingResource

java.lang.Object
com.tectonica.jonix.onix3.SupportingResource
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixSuperComposite, OnixTag, Serializable
public class SupportingResource extends Object implements OnixComposite.OnixSuperComposite, 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

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • SupportingResource

      public SupportingResource()

    • SupportingResource

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

    • ifExists

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

    • resourceContentType

      public ResourceContentType 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

      public ResourceMode 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

      public ListOfOnixCodelist<ContentAudience,ContentAudiences> 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

      public ListOfOnixComposite<ResourceVersion> 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

      public SequenceNumber 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

      public Territory 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,ResourceFeatureTypes> resourceFeatures()

      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