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

Class AVItemIdentifier

java.lang.Object
com.tectonica.jonix.onix3.AVItemIdentifier
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixDataComposite<JonixAVItemIdentifier>, OnixComposite.OnixDataCompositeWithKey<JonixAVItemIdentifier,AvItemIdentifierTypes>, OnixTag, Serializable
public class AVItemIdentifier extends Object implements OnixComposite.OnixDataCompositeWithKey<JonixAVItemIdentifier,AvItemIdentifierTypes>, Serializable

AV item identifier composite

A group of data elements which together define an identifier of an audio or audiovisual content item in accordance with a specified identifier scheme. The composite is optional, and repeatable in order to provide multiple identifiers for the content item.

Reference name <AVItemIdentifier>
Short tag <avitemidentifier>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-3.05
See Also:

  • Field Details

  • Constructor Details

    • AVItemIdentifier

      public AVItemIdentifier()

    • AVItemIdentifier

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

    • ifExists

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

    • avItemIDType

      public AVItemIDType avItemIDType()

      An ONIX code identifying the scheme from which the identifier in <IDValue> is taken. Mandatory in each occurrence of the <AVItemIdentifier> composite, and non-repeating.

      Jonix-Comment: this field is required

    • idValue

      public IDValue idValue()

      An identifier of the type specified in <AVItemIDType>. Mandatory in each occurrence of the <AVItemIdentifier> composite, and non-repeating.

      Jonix-Comment: this field is required

    • idTypeName

      public IDTypeName idTypeName()

      A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be used when, and only when, the code in <AVItemIDType> indicates a proprietary scheme, eg a publisher’s own code. Optional and non-repeating

      Jonix-Comment: this field is optional

    • asStruct

      public JonixAVItemIdentifier asStruct()
      Specified by:
      asStruct in interface OnixComposite.OnixDataComposite<JonixAVItemIdentifier>

    • structKey

      public AvItemIdentifierTypes structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixAVItemIdentifier,AvItemIdentifierTypes>