Module jonix.onix3
Package com.tectonica.jonix.onix3

Class Sender

java.lang.Object
com.tectonica.jonix.onix3.Sender
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixSuperComposite, OnixTag, Serializable
public class Sender extends Object implements OnixComposite.OnixSuperComposite, Serializable

Sender composite

A group of data elements which together specify the sender of an ONIX for Books message. Mandatory in any ONIX for Books message, and non-repeating.

Reference name <Sender>
Short tag <sender>
Cardinality 1

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • Sender

      public Sender()

    • Sender

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

    • ifExists

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

    • senderIdentifiers

      public ListOfOnixDataCompositeWithKey<SenderIdentifier,JonixSenderIdentifier,NameIdentifierTypes> senderIdentifiers()

      A group of data elements which together define an identifier of the sender. The composite is optional, and repeatable if more than one identifier of different types is sent; but either a <SenderName> or a <SenderIdentifier> must be included.

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

    • senderName

      public SenderName senderName()

      The name of the sender organization, which should always be stated in a standard form agreed with the addressee. Optional and non-repeating, but either a <SenderName> element or a <SenderIdentifier> composite must be included.

      Jonix-Comment: this field is optional

    • contactName

      public ContactName contactName()

      Free text giving the name, department, etc for a contact person in the sender organization who is responsible for the content of the message. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • telephoneNumber

      public TelephoneNumber telephoneNumber()

      A telephone number of the contact person in the sender organization, wherever possible including the plus sign and the international dialing code. Optional, and non-repeating.

      Jonix-Comment: this field is optional

    • emailAddress

      public EmailAddress emailAddress()

      A text field giving the e‑mail address for a contact person in the sender organization who is responsible for the content of the message. Optional and non-repeating.

      Jonix-Comment: this field is optional