- All Implemented Interfaces:
OnixComposite
,OnixComposite.OnixDataComposite<JonixAudience>
,OnixComposite.OnixDataCompositeWithKey<JonixAudience,
,AudienceCodeTypes> OnixTag
,Serializable
Audience composite
An optional group of data elements which together describe an audience to which the product is directed. Repeatable, both to specify multiple distinct audiences, and to express audiences using multiple schemes.
Reference name | <Audience> |
Short tag | <audience> |
Cardinality | 0…n |
- 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
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
This is an internal API.asStruct()
An ONIX code which identifies the scheme from which the code in <AudienceCodeValue> is taken.A name which identifies a proprietary audience scheme when the code in <AudienceCodeType> indicates a proprietary scheme, eg a vendor’s own coding scheme.A code value taken from the scheme specified in <AudienceCodeType>.The text of an audience heading taken from the scheme specified in the <AudienceCodeType> element; or the text equivalent to the <AudienceCodeValue> if both code and text are sent.boolean
exists()
indicates whether this tag exists in the ONIX recordFor advanced use-cases only.void
boolean
An empty element that identifies an instance of the <Audience> composite as representing the primary or main audience for the product.
-
Field Details
-
refname
- See Also:
-
shortname
- See Also:
-
datestamp
(type: dt.DateOrDateTime) -
sourcename
(type: dt.NonEmptyString) -
sourcetype
-
EMPTY
-
-
Constructor Details
-
Audience
public Audience() -
Audience
-
-
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
-
audienceCodeType
An ONIX code which identifies the scheme from which the code in <AudienceCodeValue> is taken. Mandatory in each occurrence of the <Audience> composite, and non-repeating.
Jonix-Comment: this field is required -
audienceCodeValue
A code value taken from the scheme specified in <AudienceCodeType>. Either <AudienceCodeValue> or <AudienceHeadingText> or both must be present in each occurrence of the <Audience> composite. Non-repeating.
Jonix-Comment: this field is required -
mainAudience
An empty element that identifies an instance of the <Audience> composite as representing the primary or main audience for the product. The main audience may be expressed in more than one audience scheme, ie there may be two or more instances of the <Audience> composite, using different schemes, each carrying the <MainAudience/> flag, so long as there is only one main audience per scheme (ie per value of <AudienceCodeType>). Optional and non-repeating in each occurrence of the <Audience> composite.
Jonix-Comment: this field is optional -
isMainAudience
public boolean isMainAudience() -
audienceCodeTypeName
A name which identifies a proprietary audience scheme when the code in <AudienceCodeType> indicates a proprietary scheme, eg a vendor’s own coding scheme. Optional and non-repeating.
Jonix-Comment: this field is optional -
audienceHeadingTexts
The text of an audience heading taken from the scheme specified in the <AudienceCodeType> element; or the text equivalent to the <AudienceCodeValue> if both code and text are sent. Either <AudienceCodeValue> or <AudienceHeadingText> or both must be present in each occurrence of the <Audience> composite.
Optional, and repeatable if the text is sent in multiple languages. The language attribute is optional for a single instance of <AudienceHeadingText>, but must be included in each instance if <AudienceHeadingText> is repeated.
Jonix-Comment: this list may be empty -
asStruct
- Specified by:
asStruct
in interfaceOnixComposite.OnixDataComposite<JonixAudience>
-
structKey
- Specified by:
structKey
in interfaceOnixComposite.OnixDataCompositeWithKey<JonixAudience,
AudienceCodeTypes>
-