Module jonix.onix2

Package com.tectonica.jonix.onix2

Class RightsTerritory

java.lang.Object

com.tectonica.jonix.onix2.RightsTerritory

All Implemented Interfaces:

OnixElement<Set<Regions>>, OnixTag, Serializable

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

Rights territory

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.

Format	One or more variable-length codes, each consisting of upper case letters with or without a hyphen, successive codes being separated by spaces. Suggested maximum length 100 characters.
Codelist	List 49 Where possible and appropriate, country subdivision codes are derived from the UN LOCODE scheme based on ISO 3166.
Reference name	<RightsTerritory>
Short tag	<b388>
Example	<RightsTerritory>WORLD</RightsTerritory> Whole world
	<b388>GB-EWS</b388> UK excluding Northern Ireland

This tag may be included in the following composites:

• <NotForSale>
• <SalesRights>

Possible placements within ONIX message:

• Product ⯈ NotForSale ⯈ RightsTerritory
• Product ⯈ SalesRights ⯈ RightsTerritory

Since:

Onix-2.1

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: DateOrDateTime)
static final RightsTerritory	EMPTY
Languages	language
static final String	refname
static final String	shortname
String	sourcename
RecordSourceTypes	sourcetype
TextCaseFlags	textcase
TextFormats	textformat
TransliterationSchemes	transliteration
Set<Regions>	value

Constructor Summary

Constructors

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

textformat

public TextFormats textformat

textcase

public TextCaseFlags textcase

language

public Languages language

transliteration

public TransliterationSchemes transliteration

datestamp

public String datestamp

(type: DateOrDateTime)

sourcetype

public RecordSourceTypes sourcetype

sourcename

public String sourcename

value

public Set<Regions> value

EMPTY

public static final RightsTerritory EMPTY

Constructor Details

RightsTerritory

public RightsTerritory()

RightsTerritory

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

ifExists

public void ifExists(Consumer<RightsTerritory> action)