Module jonix.onix2

Package com.tectonica.jonix.onix2

Class SenderIdentifier

java.lang.Object

com.tectonica.jonix.onix2.SenderIdentifier

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixDataComposite<JonixSenderIdentifier>, OnixComposite.OnixDataCompositeWithKey<JonixSenderIdentifier,NameIdentifierTypes>, OnixTag, Serializable

public class SenderIdentifier
extends Object
implements OnixComposite.OnixDataCompositeWithKey<JonixSenderIdentifier,NameIdentifierTypes>, 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>

This tag may be included in the following composites:

• <Header>

Possible placements within ONIX message:

• Header ⯈ SenderIdentifier

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 SenderIdentifier	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
SenderIdentifier()
SenderIdentifier(Element element)

Method Summary

Modifier and Type	Method	Description
void	_initialize()	This is an internal API.
JonixSenderIdentifier	asStruct()
boolean	exists()	indicates whether this tag exists in the ONIX record
Element	getXmlElement()	For advanced use-cases only.
IDTypeName	idTypeName()	A name which identifies a proprietary identifier type when, and only when, the code in the <SenderIDType> element indicates a proprietary scheme.
IDValue	idValue()	An identifier of the type specified in the <SenderIDType> element.
void	ifExists(Consumer<SenderIdentifier> action)
SenderIDType	senderIDType()	An ONIX code identifying the namespace from which the identifier in the <IDValue> element is taken.
NameIdentifierTypes	structKey()

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 SenderIdentifier EMPTY

Constructor Details

SenderIdentifier

public SenderIdentifier()

SenderIdentifier

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

ifExists

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

senderIDType

public SenderIDType 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

public IDValue 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

public IDTypeName 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

public JonixSenderIdentifier asStruct()

Specified by:

asStruct in interface OnixComposite.OnixDataComposite<JonixSenderIdentifier>

structKey

public NameIdentifierTypes structKey()

Specified by:

structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixSenderIdentifier,NameIdentifierTypes>