Module jonix.onix2
Package com.tectonica.jonix.onix2

Class ContainedItem

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

Contained item composite

A repeatable group of data elements which together describe an item which is part of or contained within the current product. The composite may be used to specify the item(s) and item quantity/ies carried in a dumpbin, or included in (eg) a classroom pack, or simply to state the product forms contained within a mixed media product, without specifying their identifiers or quantity. The composite is used only when the product form coding for the product as a whole indicates that the product includes two or more different items, or multiple copies of the same item.

Each instance of the <ContainedItem> composite must carry at least either a product identifier, or a product form code, or both. In other words, it is valid to send an instance of the composite with an identifier and no product form code, or with a product form code and no identifier.

Reference name <ContainedItem>
Short tag <containeditem>

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • ContainedItem

      public ContainedItem()

    • ContainedItem

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

    • ifExists

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

    • isbn

      public ISBN isbn()

      10-character ISBN of the contained item. Optional and non-repeating. The <ProductIdentifier> composite provides a more general method of handling product codes, and is preferred. The <ISBN> element is on no account to be used to carry a 13-digit ISBN.

      Jonix-Comment: this field is required

    • ean13

      public EAN13 ean13()

      EAN.UCC-13 number of the contained item. Optional and non-repeating. The <ProductIdentifier> composite provides a more general method of handling product codes, and is preferred.

      Jonix-Comment: this field is optional

    • productForm

      public ProductForm productForm()

      An ONIX code which indicates the primary form of the contained item. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • productPackaging

      public ProductPackaging productPackaging()

      An ONIX code which indicates the type of packaging used for the contained item. Optional and non-repeating. This field can only occur if the <ContainedItem> composite has a <ProductForm> code.

      Jonix-Comment: this field is optional

    • productFormDescription

      public ProductFormDescription productFormDescription()

      If product form codes do not adequately describe the contained item, a short text description may be added. Optional and non-repeating. This field can only occur if the <ContainedItem> composite has a <ProductForm> code.

      Jonix-Comment: this field is optional

    • numberOfPieces

      public NumberOfPieces numberOfPieces()

      If the contained item consists of a number of different pieces of the same form, the number may be included here. Optional and non-repeating. This field can only occur if the <ContainedItem> composite has a <ProductForm> code.

      Jonix-Comment: this field is optional

    • tradeCategory

      public TradeCategory tradeCategory()

      An ONIX code which indicates a trade category which is somewhat related to but not properly an attribute of product form. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • itemQuantity

      public ItemQuantity itemQuantity()

      For filled dumpbins and counter packs, and for retail packs containing a number of copies of the same item, the number of copies of the specified item contained in the pack. <ItemQuantity> is used to state a quantity of identical items, when a pack contains either a quantity of a single item, or a quantity of each of two or more different items (eg a dumpbin carrying copies of two different books, or a classroom pack containing a teacher’s text and twenty student texts). Optional and non-repeating.

      Jonix-Comment: this field is optional

    • productIdentifiers

      public ListOfOnixDataCompositeWithKey<ProductIdentifier,JonixProductIdentifier,ProductIdentifierTypes> productIdentifiers()

      A repeatable group of data elements which together define the identifier of a product in accordance with a specified scheme, used here to carry the product identifier of a contained item. See notes on the <ProductIdentifier> composite in section PR.2 for details of the handling of ISBN-13.

      Jonix-Comment: this list may be empty

    • productFormDetails

      public ListOfOnixCodelist<ProductFormDetail,ProductFormDetailsList78> productFormDetails()

      An ONIX code which provides added detail of the medium and/or format of the contained item. Optional and repeatable. This field can only occur if the <ContainedItem> composite has a <ProductForm> code.

      Jonix-Comment: this list may be empty

    • productFormFeatures

      public ListOfOnixDataCompositeWithKey<ProductFormFeature,JonixProductFormFeature,ProductFormFeatureTypes> productFormFeatures()

      A repeatable group of data elements which together describe an aspect of product form that is too specific to be covered in the <ProductForm> and <ProductFormDetail> elements. Optional. The <ProductFormFeature> composite can only occur if the <ContainedItem> composite has a <ProductForm> code.

      Jonix-Comment: this list may be empty

    • bookFormDetails

      public ListOfOnixCodelist<BookFormDetail,BookFormDetails> bookFormDetails()

      An ONIX code specifying more detail of the contained item when the item is a book. Optional and repeatable, and must only be included when the <ProductForm> code for the contained item begins with letter B. This field will be superseded by the new element <ProductFormDetail>, and the code list will not be further developed. The field is retained only for purposes of upwards compatibility, and its use is now to be deprecated.

      Jonix-Comment: this list may be empty

    • productContentTypes

      public ListOfOnixCodelist<ProductContentType,ProductContentTypes> productContentTypes()

      An ONIX code which indicates certain types of content which are closely related to but not strictly an attribute of product form, eg audiobook. Optional and repeatable. The element is intended to be used with products where content is delivered in the form of a digital or analogue recording. It is not expected to be used for books.

      Jonix-Comment: this list may be empty