Module jonix.onix3

Package com.tectonica.jonix.onix3

Class SalesOutlet

java.lang.Object

com.tectonica.jonix.onix3.SalesOutlet

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixSuperComposite, OnixTag, Serializable

public class SalesOutlet
extends Object
implements OnixComposite.OnixSuperComposite, Serializable

Sales outlet composite

An optional 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. Repeatable in order to identify multiple sales outlets subject to the restriction.

Reference name	<SalesOutlet>
Short tag	<salesoutlet>
Cardinality	0…n

This tag may be included in the following composites:

• <SupplementManifest>
• <CoverResource>
• <SalesRestriction>
• <InsertResource>

Possible placements within ONIX message:

• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ SupplementManifest ⯈ SalesOutlet
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ SupplementManifest ⯈ CoverManifest ⯈ CoverResource ⯈ SalesOutlet
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ CoverManifest ⯈ CoverResource ⯈ SalesOutlet
• Product ⯈ ProductSupply ⯈ Market ⯈ SalesRestriction ⯈ SalesOutlet
• Product ⯈ PublishingDetail ⯈ SalesRights ⯈ SalesRestriction ⯈ SalesOutlet
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ SupplementManifest ⯈ InsertManifest ⯈ InsertResource ⯈ SalesOutlet
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ InsertManifest ⯈ InsertResource ⯈ SalesOutlet

Since:

Onix-3.02

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: dt.DateOrDateTime)
static final SalesOutlet	EMPTY
static final String	refname
static final String	shortname
String	sourcename	(type: dt.NonEmptyString)
RecordSourceTypes	sourcetype

Constructor Summary

Constructors

Constructor	Description
SalesOutlet()
SalesOutlet(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<SalesOutlet> action)
ListOfOnixDataCompositeWithKey<SalesOutletIdentifier,JonixSalesOutletIdentifier,SalesOutletIdentifierTypes>	salesOutletIdentifiers()	An optional group of data elements which together represent a coded identification of an organization, used here to identify a sales outlet.
SalesOutletName	salesOutletName()	The name of a wholesale or retail sales outlet to which a sales restriction is linked.

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

datestamp

public String datestamp

(type: dt.DateOrDateTime)

sourcename

public String sourcename

(type: dt.NonEmptyString)

sourcetype

public RecordSourceTypes sourcetype

EMPTY

public static final SalesOutlet EMPTY

Constructor Details

SalesOutlet

public SalesOutlet()

SalesOutlet

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

ifExists

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

salesOutletIdentifiers

public ListOfOnixDataCompositeWithKey<SalesOutletIdentifier,JonixSalesOutletIdentifier,SalesOutletIdentifierTypes> salesOutletIdentifiers()

An optional group of data elements which together represent a coded identification of an organization, used here to identify a sales outlet. Repeatable in order to specify multiple identifiers for the same sales outlet.

Jonix-Comment: this list is required to contain at least one item

salesOutletName

public SalesOutletName salesOutletName()

The name of a wholesale or retail sales outlet to which a sales restriction is linked. Non-repeating.

Jonix-Comment: this field is optional