- All Implemented Interfaces:
OnixComposite
,OnixComposite.OnixSuperComposite
,OnixTag
,Serializable
Sales restriction composite
A group of data elements which together identify a non-territorial sales restriction which a publisher applies to a product within a particular territory. Optional, and repeatable if more than a single restriction applies.
Reference name | <SalesRestriction> |
Short tag | <salesrestriction> |
Cardinality | 0…n |
- <
Market
> - <
SalesRights
>
- Since:
- Onix-3.02
- See Also:
-
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
Modifier and TypeFieldDescription(type: dt.DateOrDateTime)static final SalesRestriction
static final String
static final String
(type: dt.NonEmptyString) -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
This is an internal API.endDate()
The date until which a sales restriction is effective.boolean
exists()
indicates whether this tag exists in the ONIX recordFor advanced use-cases only.void
ifExists
(Consumer<SalesRestriction> action) An optional group of data elements which together identify a sales outlet to which a restriction is linked.A free text field describing an ‘unspecified’ restriction, or giving more explanation of a coded restriction type.An ONIX code which identifies a non-territorial sales restriction.The date from which a sales restriction is effective.
-
Field Details
-
refname
- See Also:
-
shortname
- See Also:
-
datestamp
(type: dt.DateOrDateTime) -
sourcename
(type: dt.NonEmptyString) -
sourcetype
-
EMPTY
-
-
Constructor Details
-
SalesRestriction
public SalesRestriction() -
SalesRestriction
-
-
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 interfaceOnixComposite
-
exists
public boolean exists()Description copied from interface:OnixTag
indicates whether this tag exists in the ONIX record -
ifExists
-
getXmlElement
Description copied from interface:OnixComposite
For advanced use-cases only.- Specified by:
getXmlElement
in interfaceOnixComposite
- Returns:
- native representation of the XML element underlying to this tag
-
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 -
startDate
The date from which a sales restriction is effective. Optional and non-repeating.
Jonix-Comment: this field is optional -
endDate
The date until which a sales restriction is effective. Optional and non-repeating.
Jonix-Comment: this field is optional -
salesOutlets
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.
Jonix-Comment: this list may be empty -
salesRestrictionNotes
A free text field describing an ‘unspecified’ restriction, or giving more explanation of a coded restriction type. Optional, and repeatable if parallel text is provided in multiple languages. The language attribute is optional for a single instance of <SalesRestrictionNote>, but must be included in each instance if <SalesRestrictionNote> is repeated.
Jonix-Comment: this list may be empty
-