Module jonix.onix3

Package com.tectonica.jonix.onix3

Class RegionsExcluded

java.lang.Object

com.tectonica.jonix.onix3.RegionsExcluded

All Implemented Interfaces:

OnixElement<Set<Regions>>, OnixTag, Serializable

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

Regions excluded

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’).

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	<RegionsExcluded>
Short tag	<x452>
Cardinality	0…1
Example	<x452>CA-QC</x452> (Excludes Quebec)

This tag may be included in the following composites:

• <Territory>

Possible placements within ONIX message:

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

Since:

Onix-3.03

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
RegionsExcluded()
RegionsExcluded(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<RegionsExcluded> 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 RegionsExcluded EMPTY

Constructor Details

RegionsExcluded

public RegionsExcluded()

RegionsExcluded

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

ifExists

public void ifExists(Consumer<RegionsExcluded> action)