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

Class EpubLicenseExpression

java.lang.Object
com.tectonica.jonix.onix3.EpubLicenseExpression
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixDataComposite<JonixEpubLicenseExpression>, OnixComposite.OnixDataCompositeWithKey<JonixEpubLicenseExpression,LicenseExpressionTypes>, OnixTag, Serializable
public class EpubLicenseExpression extends Object implements OnixComposite.OnixDataCompositeWithKey<JonixEpubLicenseExpression,LicenseExpressionTypes>, Serializable

Digital product license expression composite

An optional composite that carries details of a link to an expression of the license terms, which may be in human-readable or machine-readable form. Repeatable when there is more than one expression of the license.

Reference name <EpubLicenseExpression>
Short tag <epublicenseexpression>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-3.02
See Also:

  • Field Details

  • Constructor Details

    • EpubLicenseExpression

      public EpubLicenseExpression()

    • EpubLicenseExpression

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

    • ifExists

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

    • epubLicenseExpressionType

      public EpubLicenseExpressionType epubLicenseExpressionType()

      An ONIX code identifying the nature or format of the license expression specified in the <EpubLicenseExpressionLink> element. Mandatory within the <EpubLicenseExpression> composite, and non-repeating.

      Jonix-Comment: this field is required

    • epubLicenseExpressionLink

      public EpubLicenseExpressionLink epubLicenseExpressionLink()

      The URI for the license expression. Mandatory in each instance of the <EpubLicenseExpression> composite, and non-repeating.

      Jonix-Comment: this field is required

    • epubLicenseExpressionTypeName

      public EpubLicenseExpressionTypeName epubLicenseExpressionTypeName()

      A short free-text name for a license expression type, when the code in <EpubLicenseExpressionType> provides insufficient detail – for example when a machine-readable license is expressed using a particular proprietary encoding scheme. Optional and non-repeating, and must be included when (and only when) the <EpubLicenseExpressionType> element indicates the expression is encoded in a proprietary way.

      Jonix-Comment: this field is optional

    • asStruct

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

    • structKey

      public LicenseExpressionTypes structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixEpubLicenseExpression,LicenseExpressionTypes>