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

Class Addressee

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

Addressee composite

A group of data elements which together specify the addressee of an ONIX for Books message. Optional, and repeatable if there are several addressees.

Reference name <Addressee>
Short tag <addressee>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • Addressee

      public Addressee()

    • Addressee

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

    • ifExists

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

    • addresseeIdentifiers

      public ListOfOnixDataCompositeWithKey<AddresseeIdentifier,JonixAddresseeIdentifier,NameIdentifierTypes> addresseeIdentifiers()

      A group of data elements which together define an identifier of the addressee. The composite is optional, and repeatable if more than one identifier of different types for the same addressee is sent; but either an <AddresseeName> or an <AddresseeIdentifier> must be included.

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

    • addresseeName

      public AddresseeName addresseeName()

      The name of the addressee organization, which should always be stated in a standard form agreed with the addressee. Optional and non-repeating; but either a <AddresseeName> element or a <AddresseeIdentifier> 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 addressee organization to whom the message is to be directed. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • telephoneNumber

      public TelephoneNumber telephoneNumber()

      A telephone number of the contact person in the addressee 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 addressee organization. Optional and non-repeating.

      Jonix-Comment: this field is optional