Module jonix.onix3

Package com.tectonica.jonix.onix3

Class RegionsIncluded

java.lang.Object

com.tectonica.jonix.onix3.RegionsIncluded

All Implemented Interfaces:

OnixElement<Set<Regions>>, OnixTag, Serializable

public class RegionsIncluded
extends Object
implements OnixElement<Set<Regions>>, Serializable

Regions included

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.

Format	One or more variable-length codes, each consisting of upper case letters, with or without a hyphen and further upper case letters or digits, and with successive codes being separated by spaces. Suggested maximum length 750 characters
Codelist	List 49 Where possible and appropriate, country subdivision codes are derived from the UN LOCODE scheme based on ISO 3166-2
Reference name	<RegionsIncluded>
Short tag	<x450>
Cardinality	0…1
Example	<x450>GB-SCT GB-NIR GB-WLS</x450> (Includes Scotland, Northern Ireland, Wales)

This tag may be included in the following composites:

• <Territory>

Possible placements within ONIX message:

• Product ⯈ ContentDetail ⯈ ContentItem ⯈ SupportingResource ⯈ Territory ⯈ RegionsIncluded
• Product ⯈ CollateralDetail ⯈ SupportingResource ⯈ Territory ⯈ RegionsIncluded
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ EventOccurrence ⯈ SupportingResource ⯈ Territory ⯈ RegionsIncluded
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ SupportingResource ⯈ Territory ⯈ RegionsIncluded
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ TextContent ⯈ Territory ⯈ RegionsIncluded
• Product ⯈ CollateralDetail ⯈ TextContent ⯈ Territory ⯈ RegionsIncluded
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ CitedContent ⯈ Territory ⯈ RegionsIncluded
• Product ⯈ CollateralDetail ⯈ CitedContent ⯈ Territory ⯈ RegionsIncluded
• Product ⯈ ProductSupply ⯈ Market ⯈ Territory ⯈ RegionsIncluded
• Product ⯈ ProductSupply ⯈ SupplyDetail ⯈ Price ⯈ Territory ⯈ RegionsIncluded
• Product ⯈ PublishingDetail ⯈ SalesRights ⯈ Territory ⯈ RegionsIncluded

Since:

Onix-3.03

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: dt.DateOrDateTime)
static final RegionsIncluded	EMPTY
static final String	refname
static final String	shortname
String	sourcename	(type: dt.NonEmptyString)
RecordSourceTypes	sourcetype
Set<Regions>	value

Constructor Summary

Constructors

Constructor	Description
RegionsIncluded()
RegionsIncluded(Element element)

Method Summary

Modifier and Type	Method	Description
Set<Regions>	__v()	Internal API, use the OnixElement.value() method or the OnixElement.value() field instead
boolean	exists()	indicates whether this tag exists in the ONIX record
void	ifExists(Consumer<RegionsIncluded> action)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tectonica.jonix.common.OnixElement

equal, is, isNull, value

Field Details

refname

public static final String refname

See Also:

• Constant Field Values

shortname

public static final String shortname

See Also:

• Constant Field Values

datestamp

public String datestamp

(type: dt.DateOrDateTime)

sourcename

public String sourcename

(type: dt.NonEmptyString)

sourcetype

public RecordSourceTypes sourcetype

value

public Set<Regions> value

EMPTY

public static final RegionsIncluded EMPTY

Constructor Details

RegionsIncluded

public RegionsIncluded()

RegionsIncluded

public RegionsIncluded(Element element)

Method Details

__v

public Set<Regions> __v()

Internal API, use the OnixElement.value() method or the OnixElement.value() field instead

Specified by:

__v in interface OnixElement<Set<Regions>>

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 (<RegionsIncluded> or <x450>) is explicitly provided in the ONIX XML

ifExists

public void ifExists(Consumer<RegionsIncluded> action)