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

Class Territory

java.lang.Object
com.tectonica.jonix.onix3.Territory
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixDataComposite<JonixTerritory>, OnixTag, Serializable
public class Territory extends Object implements OnixComposite.OnixDataComposite<JonixTerritory>, Serializable

Territory composite

A group of data elements which together define a territory for which the text in the <Text> element is specifically intended. Optional in each occurrence of the <TextContent> composite, and non-repeating. If omitted, the text is intended for use wherever the product may be sold (see Territorial sales rights in Group P.21). If included, the text should be used by recipients in the specified territory only, and in preference to any text that lacks a specified territory.

For valid combinations of <CountriesIncluded>, <RegionsIncluded> etc within <Territory>, see the notes describing the use of <Territory> within Group P.21.

Care should be taken to avoid ambiguities (for example two different ‘short descriptions’ – without language attributes or with the same language attribute – marked for use in the same country or region), and to ensure that appropriate descriptions and supporting text are supplied for all countries and regions where the product may be sold. The simplest way to accomplish the latter is to ensure at least one version of the text does not have a territory specified. Where multiple texts of the same type are provided, those without specific <Territory> composites are intended for use only where no appropriate targeted text is present.

Reference name <Territory>
Short tag <territory>
Cardinality 0…1

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-3.03
See Also:

  • Field Details

  • Constructor Details

    • Territory

      public Territory()

    • Territory

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

    • ifExists

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

    • countriesIncluded

      public CountriesIncluded countriesIncluded()

      One or more ONIX codes identifying countries included in the territory. Successive codes must be separated by spaces. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

      Jonix-Comment: this field is required

    • regionsIncluded

      public RegionsIncluded regionsIncluded()

      One or more ONIX codes identifying regions included in the territory. A region is an area which is not a country, but which is precisely defined in geographical terms, eg the World, Northern Ireland, Australian Capital Territory. Successive codes must be separated by spaces. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

      Note that if used, the ‘WORLD’ region code cannot be combined with other region codes.

      Jonix-Comment: this field is optional

    • regionsExcluded

      public RegionsExcluded regionsExcluded()

      One or more ONIX codes identifying regions excluded from the territory. Successive codes must be separated by spaces. Optional and non-repeating, and can only occur if the <CountriesIncluded> element is also present (and specifies countries of which the excluded regions are a part), or if <RegionsIncluded> is present and includes a supra-national region code (such as ‘WORLD’).

      Jonix-Comment: this field is optional

    • countriesExcluded

      public CountriesExcluded countriesExcluded()

      One or more ONIX codes identifying countries excluded from the territory. Successive codes must be separated by spaces. Optional and non-repeating, and can only occur if the <RegionsIncluded> element is also present and includes a supra-national region code (such as ‘WORLD’).

      Jonix-Comment: this field is optional

    • asStruct

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