Module jonix.onix2
Package com.tectonica.jonix.onix2

Class SalesRights

java.lang.Object
com.tectonica.jonix.onix2.SalesRights
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixDataCompositeUncommon, OnixTag, Serializable
public class SalesRights extends Object implements OnixComposite.OnixDataCompositeUncommon, Serializable

Sales rights composite

A repeatable group of data elements which together identify territorial sales rights which a publisher chooses to exercise in a product. The <SalesRights> composite may occur once for each value of <b089>. See examples at the end of Group PR.21.

Reference name <SalesRights>
Short tag <salesrights>

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • SalesRights

      public SalesRights()

    • SalesRights

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

    • ifExists

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

    • salesRightsType

      public SalesRightsType salesRightsType()

      An ONIX code which identifies the type of sales right or exclusion which applies in the territories which are associated with it. Mandatory in each occurrence of the <SalesRights>composite, and non-repeating.

      Jonix-Comment: this field is required

    • rightsCountrys

      public ListOfOnixElement<RightsCountry,Set<Countrys>> rightsCountrys()

      One or more ISO standard codes identifying a country. Successive codes may be separated by spaces. Thus, a single occurrence of the element can carry an unlimited number of country codes, for countries that share the sales rights specified in <SalesRightsType>. For upwards compatibility, the element remains repeatable, so that multiple countries can also be listed as multiple occurrences of the whole element. At least one occurrence of <RightsCountry> or <RightsTerritory> or <RightsRegion> is mandatory in any occurrence of the<SalesRights> composite.

      Jonix-Comment: this list is required to contain at least one item

    • rightsTerritory

      public RightsTerritory rightsTerritory()

      One or more ONIX codes identifying a territory which is not a country, but which is precisely defined in geographical terms, eg World, Northern Ireland, Australian National Territory. Successive codes are separated by spaces, so that the element can carry an unlimited number of territory codes, for territories that share the sales rights specified in <SalesRightsType>. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • rightsRegions

      public ListOfOnixCodelist<RightsRegion,RightsRegions> rightsRegions()

      An ONIX code identifying a territorial market which cannot be described in terms of ISO country codes. Optional, and repeatable for as many regions as share the sales rights specified in <SalesRightsType>. Superseded by the new element <RightsTerritory> above, but retained for purposes of upwards compatibility. See note on “Open Market” and “Airport” or “Airside” editions in the introduction to Group PR.21.

      Jonix-Comment: this list may be empty