- All Implemented Interfaces:
OnixComposite
,OnixComposite.OnixDataComposite<JonixOtherText>
,OnixComposite.OnixDataCompositeWithKey<JonixOtherText,
,OtherTextTypes> OnixTag
,Serializable
Other text composite
An optional and repeatable group of data elements which together identify and either include, or provide pointers to, text related to the product.
Reference name | <OtherText> |
Short tag | <othertext> |
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.tectonica.jonix.common.OnixComposite
OnixComposite.OnixDataComposite<V extends JonixStruct>, OnixComposite.OnixDataCompositeUncommon, OnixComposite.OnixDataCompositeWithKey<V extends JonixKeyedStruct<K>,
K extends Enum<K> & OnixCodelist>, OnixComposite.OnixSuperComposite -
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
This is an internal API.asStruct()
endDate()
The date until which text sent in the <Text> element, or referenced in the <TextLink> element, is intended to be used, eg for date-limited promotions.boolean
exists()
indicates whether this tag exists in the ONIX recordFor advanced use-cases only.void
The date from which text sent in the <Text> element, or referenced in the <TextLink> element, is intended to be used, eg for date-limited promotions.text()
The text specified in the <TextTypeCode> element, if it is suitable to be sent in full as part of the ONIX record.The name of the author of text sent in the <Text> element, or referenced in the <TextLink> element, eg if it is a review or promotional quote.An ONIX code which identifies the format of text which is sent in the <Text> element, or referenced in the <TextLink> element.textLink()
A link to the text item specified in the <TextTypeCode> element, using the link type specified in <TextLinkType>.An ONIX code which identifies the type of link which is given in the <TextLink> element.The date on which text sent in the <Text> element, or referenced in the <TextLink> element, was published.The name of a company or corporate body responsible for the text sent in the <Text> element, or referenced in the <TextLink> element, eg if it is part of a Reading Group Guide.The title of a publication from which the text sent in the <Text> element, or referenced in the <TextLink> element, was taken, eg if it is a review quote.An ONIX code which identifies the type of text which is sent in the <Text> element, or referenced in the <TextLink> element.
-
Field Details
-
refname
- See Also:
-
shortname
- See Also:
-
textformat
-
textcase
-
language
-
transliteration
-
datestamp
(type: DateOrDateTime) -
sourcetype
-
sourcename
-
EMPTY
-
-
Constructor Details
-
OtherText
public OtherText() -
OtherText
-
-
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 interfaceOnixComposite
-
exists
public boolean exists()Description copied from interface:OnixTag
indicates whether this tag exists in the ONIX record -
ifExists
-
getXmlElement
Description copied from interface:OnixComposite
For advanced use-cases only.- Specified by:
getXmlElement
in interfaceOnixComposite
- Returns:
- native representation of the XML element underlying to this tag
-
textTypeCode
An ONIX code which identifies the type of text which is sent in the <Text> element, or referenced in the <TextLink> element. Mandatory in each occurrence of the <OtherText> composite, and non-repeating.
Jonix-Comment: this field is required -
textLinkType
An ONIX code which identifies the type of link which is given in the <TextLink> element.
Jonix-Comment: this field is required -
textLink
A link to the text item specified in the <TextTypeCode> element, using the link type specified in <TextLinkType>.
Jonix-Comment: this field is required -
textFormat
An ONIX code which identifies the format of text which is sent in the <Text> element, or referenced in the <TextLink> element. Optional and non-repeating. It is now possible to use a “textformat” attribute in the <Text> element for this purpose, and this is the recommended practise when the text is sent in the ONIX record. The <TextFormat> element may still be used when the text is held outside the ONIX record, and referenced by the <TextLink> element.
Jonix-Comment: this field is optional -
text
The text specified in the <TextTypeCode> element, if it is suitable to be sent in full as part of the ONIX record. Either the <Text> element or both of the <TextLinkType> and <TextLink> elements must be present in any occurrence of the <OtherText> composite. Non-repeating.
The <Text> element may carry any of the following ONIX attributes: textformat, language, transliteration, textcase.
Jonix-Comment: this field is optional -
textAuthor
The name of the author of text sent in the <Text> element, or referenced in the <TextLink> element, eg if it is a review or promotional quote.
Jonix-Comment: this field is optional -
textSourceCorporate
The name of a company or corporate body responsible for the text sent in the <Text> element, or referenced in the <TextLink> element, eg if it is part of a Reading Group Guide. Optional and non-repeating.
Jonix-Comment: this field is optional -
textSourceTitle
The title of a publication from which the text sent in the <Text> element, or referenced in the <TextLink> element, was taken, eg if it is a review quote. Optional and non-repeating.
Jonix-Comment: this field is optional -
textPublicationDate
The date on which text sent in the <Text> element, or referenced in the <TextLink> element, was published. Optional and non-repeating.
Jonix-Comment: this field is optional -
startDate
The date from which text sent in the <Text> element, or referenced in the <TextLink> element, is intended to be used, eg for date-limited promotions. Optional and non-repeating, but either both or neither of <StartDate> and <EndDate> must be present.
Jonix-Comment: this field is optional -
endDate
The date until which text sent in the <Text> element, or referenced in the <TextLink> element, is intended to be used, eg for date-limited promotions. Optional and non-repeating, but either both or neither of <StartDate> and <EndDate> must be present.
Jonix-Comment: this field is optional -
asStruct
- Specified by:
asStruct
in interfaceOnixComposite.OnixDataComposite<JonixOtherText>
-
structKey
- Specified by:
structKey
in interfaceOnixComposite.OnixDataCompositeWithKey<JonixOtherText,
OtherTextTypes>
-