- All Implemented Interfaces:
OnixElement<String>
,OnixTag
,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) |
- <
Product
>
- See Also:
-
Field Summary
Modifier and TypeFieldDescription(type: dt.DateOrDateTime)static final RecordReference
static final String
static final String
(type: dt.NonEmptyString)This is the raw content of RecordReference. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescription__v()
Internal API, use theOnixElement.value()
method or theOnixElement.value()
field insteadboolean
exists()
indicates whether this tag exists in the ONIX recordvoid
ifExists
(Consumer<RecordReference> action) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.tectonica.jonix.common.OnixElement
equal, is, isNull, value
-
Field Details
-
refname
- See Also:
-
shortname
- See Also:
-
datestamp
(type: dt.DateOrDateTime) -
sourcename
(type: dt.NonEmptyString) -
sourcetype
-
value
This is the raw content of RecordReference. Could be null ifexists() == false
. UseOnixElement.value()
instead if you want to get this as anOptional
.Raw Format: Variable length alphanumeric, suggested maximum length 100 characters
(type: dt.NonEmptyString)
-
EMPTY
-
-
Constructor Details
-
RecordReference
public RecordReference() -
RecordReference
-
-
Method Details
-
__v
Internal API, use theOnixElement.value()
method or theOnixElement.value()
field instead- Specified by:
__v
in interfaceOnixElement<String>
-
exists
public boolean exists()Description copied from interface:OnixTag
indicates whether this tag exists in the ONIX record -
ifExists
-