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

Class ProductionManifest

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

Production manifest composite

A group of data elements which together carry manifest details for a single Product or Product part.

Reference name <ProductionManifest>
Short tag <productionmanifest>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-3.08
See Also:

  • Field Details

  • Constructor Details

    • ProductionManifest

      public ProductionManifest()

    • ProductionManifest

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

    • ifExists

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

    • bodyManifest

      public BodyManifest bodyManifest()

      A group of data elements which together provide manifest details for the body of a Product or Product part. These details include:

      • technical specifications for the body;
      • details of the file resources required to create the body.

      Note that the high-level specifications such as the Product form and size are carried in Block 1 – the manifest specifications are more detailed in nature, and must be consistent with the high-level specifications.

      Technical specifications in the manifest can be provided either as a pre-defined and named ‘bundle’ encompassing all the required technical details, and/or as a set of individually-specified details. Bundle names are inevitably proprietary. It is possible to provide two or more bundle names if, for example, a physical book is set up for on-demand manufacturing by multiple POD suppliers, and a supplier who does not pre-define bundles can use the individually-specified details.

      The composite is mandatory and is not repeatable.

      Jonix-Comment: this field is required

    • coverManifest

      public CoverManifest coverManifest()

      A group of data elements which together provide manifest details for the cover of a Product or Product part. These details include:

      • technical specifications for the cover;
      • details of the file resources required to create the cover.

      Note that the high-level specifications such as the Product form or overall size are carried in Block 1 – the manifest specifications are more detailed in nature, and must be consistent with the high-level specifications.

      Technical specifications in the manifest can be provided either as a pre-defined and named ‘bundle’ encompassing all the required technical details, and/or as a set of individually-specified details. Bundle names are inevitably proprietary. It is possible to provide two or more bundle names if, for example, a physical book is set up for on-demand manufacturing by multiple POD suppliers, and a supplier who does not pre-define bundles can use the individually-specified details.

      The composite is optional – it may be omitted where the Product or Product part has no cover – and is not repeatable.

      Jonix-Comment: this field is optional

    • productIdentifiers

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

      A group of data elements which together specify a product identifier, used here to carry an identifier which must match a product identifier in an instance of the <ProductPart> composite within Group P.4. The composite is mandatory and repeatable when <ProductPart> is present within the Product record, but must be omitted if there are no product parts. Where multiple product identifiers are provided in any one occurrence of the <ProductionManifest> composite, they must all identify the same product part.

      Jonix-Comment: this list may be empty

    • insertManifests

      public ListOfOnixComposite<InsertManifest> insertManifests()

      A group of data elements which together provide manifest details for a single insert within the Product or Product part. These details include:

      • technical specifications for the insert within the final product;
      • details of the file resources required to create the insert;

      Note that the high-level specifications such as the Product form, trimmed page size or file type for final delivery are carried in Block 1 – the manifest specifications are more detailed in nature, and must be consistent with the high-level specifications.

      Technical specifications in the manifest can be provided either as a pre-defined and named ‘bundle’ encompassing all the required technical details, and/or as a set of individually-specified details. Bundle names are inevitably proprietary. It is possible to provide two or more bundle names if, for example, a physical book is set up for on-demand manufacturing by multiple POD suppliers, and a supplier who does not pre-define bundles can use the individually-specified details.

      The composite is optional – it may be omitted where the Product or Product part has no inserts – and is repeatable to provide manifest details for multiple inserts.

      Jonix-Comment: this list may be empty

    • supplementManifests

      public ListOfOnixComposite<SupplementManifest> supplementManifests()

      An optional group of data elements detailing a simple subset of Group P.1 to specify the Product form, an optional cover, mandatory body and optionally one or more insert manifests for a single Supplement – an additional item supplied with the product at retail that is NOT considered a <ProductPart>, for example a booklet supplied in PDF form that accompanies a downloadable audio product. Each of these cover, body and insert sections within <SupplementManifest> mirrors the structure of the parts of a <ProductionManifest>.

      These manifests may be preceded by a <SequenceNumber> and one or more <SalesOutlet> composites to enable vendor-specific supplements, and a simple <NoSupplement/> indicator may replace the Product form and cover, body and insert manifests to provide a positive indication that a vendor-specific supplement has no ‘generic’ alternative.

      Jonix-Comment: this list may be empty