Module jonix.onix2

Package com.tectonica.jonix.onix2

Class SalesRestriction

java.lang.Object

com.tectonica.jonix.onix2.SalesRestriction

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixSuperComposite, OnixTag, Serializable

public class SalesRestriction
extends Object
implements OnixComposite.OnixSuperComposite, Serializable

Sales restriction composite

A group of data elements which together identify a non-territorial sales restriction which a publisher applies to a product. Optional and repeatable.

Reference name	<SalesRestriction>
Short tag	<salesrestriction>

This tag may be included in the following composites:

• <Product>

Possible placements within ONIX message:

• Product ⯈ SalesRestriction

Since:

Onix-2.1

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.tectonica.jonix.common.OnixComposite

OnixComposite.OnixDataComposite<V extends JonixStruct>, OnixComposite.OnixDataCompositeUncommon, OnixComposite.OnixDataCompositeWithKey<V extends JonixKeyedStruct<K>,K extends Enum<K> & OnixCodelist>, OnixComposite.OnixSuperComposite

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
SalesRestriction()
SalesRestriction(Element element)

Method Summary

Modifier and Type	Method	Description
void	_initialize()	This is an internal API.
boolean	exists()	indicates whether this tag exists in the ONIX record
Element	getXmlElement()	For advanced use-cases only.
void	ifExists(Consumer<SalesRestriction> action)
ListOfOnixComposite<SalesOutlet>	salesOutlets()	An optional and repeatable group of data elements which together identify a sales outlet to which a restriction is linked.
SalesRestrictionDetail	salesRestrictionDetail()	A free text field describing an “unspecified” restriction, or giving more explanation of a coded restriction type.
SalesRestrictionType	salesRestrictionType()	An ONIX code which identifies a non-territorial sales restriction.

Methods inherited from class java.lang.Object

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

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

EMPTY

public static final SalesRestriction EMPTY

Constructor Details

SalesRestriction

public SalesRestriction()

SalesRestriction

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

ifExists

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

salesRestrictionType

public SalesRestrictionType salesRestrictionType()

An ONIX code which identifies a non-territorial sales restriction. Mandatory in each occurrence of the <SalesRestriction> composite, and non-repeating.

Jonix-Comment: this field is required

salesRestrictionDetail

public SalesRestrictionDetail salesRestrictionDetail()

A free text field describing an “unspecified” restriction, or giving more explanation of a coded restriction type. Optional and non-repeating.

Jonix-Comment: this field is optional

salesOutlets

public ListOfOnixComposite<SalesOutlet> salesOutlets()

An optional and repeatable group of data elements which together identify a sales outlet to which a restriction is linked. Each occurrence of the composite must include a <SalesOutletIdentifier> composite or a <SalesOutletName> or both.

Jonix-Comment: this list may be empty