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

Class RecordReference

java.lang.Object
com.tectonica.jonix.onix3.RecordReference
All Implemented Interfaces:
OnixElement<String>, OnixTag, Serializable
public class RecordReference extends Object implements OnixElement<String>, Serializable

Record reference

For every product, you must choose a single record reference 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 reference you choose, provided that it is unique and permanent. This record reference doesn’t identify the product – even though you may choose to use the ISBN or another product identifier as a part of your record reference – 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. It is not recommended to use a product identifier as the whole of the record reference. A good way of generating references which are not part of a recognized product identification scheme but which can be guaranteed to be unique is to prefix a product identifier or a meaningless row ID from your internal database with a reversed Internet domain name which is registered to your organization (reversal prevents the record reference appearing to be a resolvable URL). Alternatively, use a UUID.

This field is mandatory and non-repeating.

Format Variable length alphanumeric, suggested maximum length 100 characters
Reference name <RecordReference>
Short tag <a001>
Cardinality 1
Example <a001>com.xyzpublishers.onix.36036</a001> (36036 is a row ID in an internal database that is the source of the data in the record)

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

    • refname

      public static final String refname
      See Also:

    • shortname

      public static final String shortname
      See Also:

    • datestamp

      public String datestamp
      (type: dt.DateOrDateTime)

    • sourcename

      public String sourcename
      (type: dt.NonEmptyString)

    • sourcetype

      public RecordSourceTypes sourcetype

    • value

      public String value
      This is the raw content of RecordReference. Could be null if exists() == false. Use OnixElement.value() instead if you want to get this as an Optional.

      Raw Format: Variable length alphanumeric, suggested maximum length 100 characters

      (type: dt.NonEmptyString)

    • EMPTY

      public static final RecordReference EMPTY

  • Constructor Details

    • RecordReference

      public RecordReference()

    • RecordReference

      public RecordReference(Element element)

  • Method Details