- All Implemented Interfaces:
OnixComposite
,OnixComposite.OnixDataComposite<JonixSenderIdentifier>
,OnixComposite.OnixDataCompositeWithKey<JonixSenderIdentifier,
,NameIdentifierTypes> OnixTag
,Serializable
Sender identifier composite
A group of data elements which together define the identifier of the sender within a specified namespace, used here to allow different party identifiers to be included without defining additional data elements. In particular the composite allows a proprietary identifier to be used by mutual agreement between parties to an exchange. The composite is optional and repeatable; but either the <FromCompany> element or a sender identifier using one or more elements from MH.1 to MH.5 must be included.
Reference name | <SenderIdentifier> |
Short tag | <senderidentifier> |
- <
Header
>
- 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: DateOrDateTime)static final SenderIdentifier
static final String
static final String
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
This is an internal API.asStruct()
boolean
exists()
indicates whether this tag exists in the ONIX recordFor advanced use-cases only.A name which identifies a proprietary identifier type when, and only when, the code in the <SenderIDType> element indicates a proprietary scheme.idValue()
An identifier of the type specified in the <SenderIDType> element.void
ifExists
(Consumer<SenderIdentifier> action) An ONIX code identifying the namespace from which the identifier in the <IDValue> element is taken.
-
Field Details
-
refname
- See Also:
-
shortname
- See Also:
-
textformat
-
textcase
-
language
-
transliteration
-
datestamp
(type: DateOrDateTime) -
sourcetype
-
sourcename
-
EMPTY
-
-
Constructor Details
-
SenderIdentifier
public SenderIdentifier() -
SenderIdentifier
-
-
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
-
senderIDType
An ONIX code identifying the namespace from which the identifier in the <IDValue> element is taken. Mandatory in any occurrence of the <SenderIdentifier> composite, and non-repeating.
Jonix-Comment: this field is required -
idValue
An identifier of the type specified in the <SenderIDType> element. Mandatory in any occurrence of the <SenderIdentifier> composite, and non-repeating.
Jonix-Comment: this field is required -
idTypeName
A name which identifies a proprietary identifier type when, and only when, the code in the <SenderIDType> element indicates a proprietary scheme. Optional and non-repeating.
The text is not limited to ASCII characters.
Jonix-Comment: this field is optional -
asStruct
- Specified by:
asStruct
in interfaceOnixComposite.OnixDataComposite<JonixSenderIdentifier>
-
structKey
- Specified by:
structKey
in interfaceOnixComposite.OnixDataCompositeWithKey<JonixSenderIdentifier,
NameIdentifierTypes>
-