Module jonix.onix2
Package com.tectonica.jonix.onix2

Class SubSeriesRecord

java.lang.Object
com.tectonica.jonix.onix2.SubSeriesRecord
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixSuperComposite, OnixTag, Serializable
public class SubSeriesRecord extends Object implements OnixComposite.OnixSuperComposite, Serializable
This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • SubSeriesRecord

      public SubSeriesRecord()

    • SubSeriesRecord

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

    • ifExists

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

    • recordReference

      public RecordReference recordReference()

      For every product, you must choose a single number which will uniquely identify the Information record which you send out about that product, and which will remain as its permanent identifier every time you send an update. It doesn’t matter what number you choose, provided that it is unique and permanent. This number doesn’t really identify the product – even though you may choose to use the ISBN or another product identifier – it identifies your information record about the product, so that the person to whom you are sending an update can match it with what you have previously sent. A good way of generating numbers which are not part of a recognized product identification scheme but which can be guaranteed to be unique is to preface the number with an Internet domain name which is registered to your organisation.

      This field is mandatory and non-repeating.

      Jonix-Comment: this field is required

    • notificationType

      public NotificationType notificationType()

      An ONIX code which indicates the type of notification or update which you are sending. Mandatory and non-repeating.

      Jonix-Comment: this field is required

    • parentIdentifier

      public ParentIdentifier parentIdentifier()
      Jonix-Comment: this field is required

    • levelSequenceNumber

      public LevelSequenceNumber levelSequenceNumber()
      Jonix-Comment: this field is required

    • seriesIdentifiers

      public ListOfOnixDataCompositeWithKey<SeriesIdentifier,JonixSeriesIdentifier,CollectionIdentifierTypes> seriesIdentifiers()

      A repeatable group of data elements which together define an identifier of a series or subseries. The composite is optional, and may only repeat if two or more identifiers of different types are sent. It is not permissible to have two identifiers of the same type.

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

    • titles

      public ListOfOnixDataCompositeWithKey<Title,JonixTitle,TitleTypes> titles()
      Jonix-Comment: this list is required to contain at least one item

    • deletionCode

      public DeletionCode deletionCode()

      An ONIX code which indicates the reason why an ONIX record is being deleted. Optional and non-repeating; and may occur only when the <NotificationType> element carries the code value 05. Note that it refers to the reason why the record is being deleted, not the reason why a product has been “deleted” (in industries which use this terminology when a product is withdrawn).

      Jonix-Comment: this field is optional

    • deletionText

      public DeletionText deletionText()

      Free text which indicates the reason why an ONIX record is being deleted. Optional and non-repeating; and may occur only when the <NotificationType> element carries the code value 05. Note that it refers to the reason why the record is being deleted, not the reason why a product has been “deleted” (in industries which use this terminology when a product is withdrawn).

      Jonix-Comment: this field is optional

    • recordSourceType

      public RecordSourceType recordSourceType()

      An ONIX code which indicates the type of source which has issued the ONIX record. Optional and non-repeating, independently of the occurrence of any other field.

      Jonix-Comment: this field is optional

    • recordSourceIdentifierType

      public RecordSourceIdentifierType recordSourceIdentifierType()

      An ONIX code identifying the scheme from which the identifier in the <RecordSourceIdentifier> element is taken. Optional and non-repeating, but <RecordSourceIdentifier> must also be present if this field is present.

      Jonix-Comment: this field is optional

    • recordSourceIdentifier

      public RecordSourceIdentifier recordSourceIdentifier()

      An identifier for the party which issued the record, from the scheme specified in <RecordSourceIdentifierType>. Optional and non-repeating, but <RecordSourceIdentifierType> must also be present if this field is present.

      Jonix-Comment: this field is optional

    • recordSourceName

      public RecordSourceName recordSourceName()

      The name of the party which issued the record, as free text. Optional and non-repeating, independently of the occurrence of any other field.

      Jonix-Comment: this field is optional

    • seriesPartName

      public SeriesPartName seriesPartName()
      Jonix-Comment: this field is optional

    • numberWithinSeries

      public NumberWithinSeries numberWithinSeries()

      The distinctive enumeration of a product within a series. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • subordinateEntries

      public SubordinateEntries subordinateEntries()
      Jonix-Comment: this field is optional

    • contributors

      public ListOfOnixComposite<Contributor> contributors()
      Jonix-Comment: this list may be empty

    • otherTexts

      public ListOfOnixDataCompositeWithKey<OtherText,JonixOtherText,OtherTextTypes> otherTexts()
      Jonix-Comment: this list may be empty

    • publishers

      public ListOfOnixComposite<Publisher> publishers()
      Jonix-Comment: this list may be empty