Module jonix.onix3

Package com.tectonica.jonix.onix3

Class CountriesIncluded

java.lang.Object

com.tectonica.jonix.onix3.CountriesIncluded

All Implemented Interfaces:

OnixElement<Set<Countrys>>, OnixTag, Serializable

public class CountriesIncluded
extends Object
implements OnixElement<Set<Countrys>>, Serializable

Countries included

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.

Format	One or more fixed-length codes based on ISO 3166-1, each consisting of two upper case letters, and with successive codes being separated by spaces. Suggested maximum length 750 characters. Note that ISO 3166-1 specifies that country codes shall be sent as upper case only
Codelist	List 91
Reference name	<CountriesIncluded>
Short tag	<x449>
Cardinality	0…1
Example	<CountriesIncluded>US CA</CountriesIncluded> (USA and Canada)

This tag may be included in the following composites:

• <Territory>

Possible placements within ONIX message:

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

Since:

Onix-3.03

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
CountriesIncluded()
CountriesIncluded(Element element)

Method Summary

Modifier and Type	Method	Description
Set<Countrys>	__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<CountriesIncluded> 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<Countrys> value

EMPTY

public static final CountriesIncluded EMPTY

Constructor Details

CountriesIncluded

public CountriesIncluded()

CountriesIncluded

public CountriesIncluded(Element element)

Method Details

__v

public Set<Countrys> __v()

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

Specified by:

__v in interface OnixElement<Set<Countrys>>

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

ifExists

public void ifExists(Consumer<CountriesIncluded> action)