Module jonix.onix2

Package com.tectonica.jonix.onix2

Class ProductWebsite

java.lang.Object

com.tectonica.jonix.onix2.ProductWebsite

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixDataComposite<JonixProductWebsite>, OnixTag, Serializable

public class ProductWebsite
extends Object
implements OnixComposite.OnixDataComposite<JonixProductWebsite>, Serializable

Product website composite

An optional and repeatable group of data elements which together identify and provide pointers to a website which is related to the product.

Reference name	<ProductWebsite>
Short tag	<productwebsite>

This tag may be included in the following composites:

• <Product>

Possible placements within ONIX message:

• Product ⯈ ProductWebsite

See Also:

• Serialized Form

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

Fields

Modifier and Type	Field	Description
String	datestamp	(type: DateOrDateTime)
static final ProductWebsite	EMPTY
Languages	language
static final String	refname
static final String	shortname
String	sourcename
RecordSourceTypes	sourcetype
TextCaseFlags	textcase
TextFormats	textformat
TransliterationSchemes	transliteration

Constructor Summary

Constructors

Constructor	Description
ProductWebsite()
ProductWebsite(Element element)

Method Summary

Modifier and Type	Method	Description
void	_initialize()	This is an internal API.
JonixProductWebsite	asStruct()
boolean	exists()	indicates whether this tag exists in the ONIX record
Element	getXmlElement()	For advanced use-cases only.
void	ifExists(Consumer<ProductWebsite> action)
ProductWebsiteDescription	productWebsiteDescription()	Free text describing the nature of the website which is linked through <ProductWebsiteLink>.
ProductWebsiteLink	productWebsiteLink()	A URL for a website carrying additional information related to the product, which is available to be viewed for promotional purposes.
WebsiteRole	websiteRole()	An ONIX code which identifies the role or purpose of the website which is linked through <ProductWebsiteLink>.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

refname

public static final String refname

See Also:

• Constant Field Values

shortname

public static final String shortname

See Also:

• Constant Field Values

textformat

public TextFormats textformat

textcase

public TextCaseFlags textcase

language

public Languages language

transliteration

public TransliterationSchemes transliteration

datestamp

public String datestamp

(type: DateOrDateTime)

sourcetype

public RecordSourceTypes sourcetype

sourcename

public String sourcename

EMPTY

public static final ProductWebsite EMPTY

Constructor Details

ProductWebsite

public ProductWebsite()

ProductWebsite

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

ifExists

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

productWebsiteLink

public ProductWebsiteLink productWebsiteLink()

A URL for a website carrying additional information related to the product, which is available to be viewed for promotional purposes. Mandatory in each occurrence of the <ProductWebsite> composite, and non-repeating.

Jonix-Comment: this field is required

websiteRole

public WebsiteRole websiteRole()

An ONIX code which identifies the role or purpose of the website which is linked through <ProductWebsiteLink>. Optional and non-repeating.

Jonix-Comment: this field is optional

productWebsiteDescription

public ProductWebsiteDescription productWebsiteDescription()

Free text describing the nature of the website which is linked through <ProductWebsiteLink>. Optional and non-repeating.

Jonix-Comment: this field is optional

asStruct

public JonixProductWebsite asStruct()

Specified by:

asStruct in interface OnixComposite.OnixDataComposite<JonixProductWebsite>