Module jonix.onix2

Class Website

java.lang.Object
com.tectonica.jonix.onix2.Website
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixDataComposite<JonixWebsite>, OnixTag, Serializable

public class Website extends Object implements OnixComposite.OnixDataComposite<JonixWebsite>, Serializable

Website composite

A repeatable group of data elements which together identify and provide pointers to a website which is related to the work identified in an occurrence of the <WorkIdentifier> composite.

Reference name <Website>
Short tag <website>

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-2.1
See Also:
  • Field Details

  • Constructor Details

    • Website

      public Website()
    • Website

      public Website(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 (<Website> or <website>) is explicitly provided in the ONIX XML
    • ifExists

      public void ifExists(Consumer<Website> 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
    • websiteLink

      public WebsiteLink websiteLink()

      The URL for the website. Mandatory in each occurrence of the <Website> 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 the <WebsiteLink> element. Optional and non-repeating.

      Jonix-Comment: this field is optional
    • websiteDescription

      public WebsiteDescription websiteDescription()

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

      Jonix-Comment: this field is optional
    • asStruct

      public JonixWebsite asStruct()
      Specified by:
      asStruct in interface OnixComposite.OnixDataComposite<JonixWebsite>