Module jonix.common
Package com.tectonica.jonix.common.codelist

Enum Class ProductRelations

java.lang.Object
java.lang.Enum<ProductRelations>
com.tectonica.jonix.common.codelist.ProductRelations
All Implemented Interfaces:
OnixCodelist, Serializable, Comparable<ProductRelations>, Constable
public enum ProductRelations extends Enum<ProductRelations> implements OnixCodelist
Enum that corresponds to ONIX Codelist 51

Description: Product relation

See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

    Nested classes/interfaces inherited from interface com.tectonica.jonix.common.OnixCodelist

    OnixCodelist.Pair

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Adapted_as
    <Product> is the original from which <RelatedProduct> is adapted (dramatized etc) (inverse of code 43).
    Adapted_from
    <Product> is an adapted (dramatized, abridged, novelized etc) version of <RelatedProduct> (inverse of code 44).
    Alternative_format
    <Product> is available in an alternative format as <RelatedProduct> - indicates an alternative format of the same content which is or may be available (is own inverse)
    Basic_version_available_as
    <RelatedProduct> is a basic version of <Product>.
    Cites
    <Product> cites <RelatedProduct> (inverse of code 35)
    Electronic_version_available_as
    <RelatedProduct> is an electronic version of print <Product> (inverse of code 13)
    Enhanced_version_available_as
    <RelatedProduct> is an 'enhanced' version of <Product>, with additional content.
    Epublication_based_on_print_product
    <Product> is an epublication based on printed product <RelatedProduct>.
    Epublication_is_a_rendering_of
    <Product> is a 'rendering' of an epublication <RelatedProduct>: use in ONIX 2.1 only when the <Product> record describes a specific rendering of an epublication content package, to identify the package: NOT USED in ONIX 3.0
    Epublication_is_distributed_as
    <Product> is an epublication 'rendered' as <RelatedProduct>: use in ONIX 2.1 only when the <Product> record describes a package of electronic content which is available in multiple 'renderings' (coded 000 in <EpubTypeCode>): NOT USED in ONIX 3.0
    Has_alternative_in_a_different_market_sector
    <RelatedProduct> is an alternative product in another sector (of the same geographical market).
    Has_alternative_intended_for_different_market
    <RelatedProduct> is an alternative product, often intended for another (geographical) market.
    Has_ancillary_product
    <Product> has an ancillary or supplementary product <RelatedProduct> (inverse of code 08)
    Has_companion_product
    <Product> and <RelatedProduct> are companion products, intended to be used, or are usable, together (is own inverse).
    Has_equivalent_intended_for_a_different_market
    <RelatedProduct> is an equivalent product, often intended for another (geographical) market.
    Has_linked_product_offer
    Purchases of <Product> may qualify for one or more copies of <RelatedProduct> either free of charge or at a reduced price (inverse of code 48).
    Has_related_student_material
    <Product> is intended for teacher use, and the related product is for student use
    Has_related_teacher_material
    <Product> is intended for student use, and the related product is for teacher use
    Has_signed_version
    <Product> is an unsigned copy of <RelatedProduct>.
    Has_special_edition
    <Product> has a special edition <RelatedProduct> (inverse of code 18)
    Includes
    <Product> includes <RelatedProduct> (inverse of code 02)
    Is_ancillary_to
    <Product> is ancillary or supplementary to <RelatedProduct> (inverse of code 07)
    Is_cited_by
    <Product> is the object of a citation in <RelatedProduct> (inverse of code 34)
    Is_facsimile_of
    <Product> is a facsimile edition of <RelatedProduct> (inverse of code 25)
    Is_later_edition_of_first_edition
    <Product> is a later edition of <RelatedProduct>, where the related product is the first edition
    Is_license_for
    <Product> is a license for a digital <RelatedProduct>, traded or supplied separately
    Is_linked_product_offer
    Purchases of <RelatedProduct> may qualify for one or more copies of <Product> either free of charge or at a reduced price (inverse of code 45).
    Is_original_of_facsimile
    <Product> is the original edition from which a facsimile edition <RelatedProduct> is taken (inverse of code 24)
    Is_original_of_prebound_edition
    <Product> is the regular edition of which <RelatedProduct> is a prebound edition (inverse of code 20)
    Is_other_language_version_of
    <Product> is an other-language version of <RelatedProduct> (is own inverse)
    Is_part_of
    <Product> is part of <RelatedProduct>: use for 'also available as part of' (inverse of code 01)
    Is_prebound_edition_of
    <Product> is a prebound edition of <RelatedProduct> (In the US, a 'prebound' edition is 'a book that was previously bound and has been rebound with a library quality hardcover binding.
    Is_remainder_of
    <Product> was originally sold as <RelatedProduct>, indicating the publisher's original identifier for a title which is offered as a remainder under a different identifier (inverse of code 09)
    Is_remaindered_as
    <Product> is remaindered as <RelatedProduct>, when a remainder merchant assigns its own identifier to the product (inverse of code 10)
    Is_signed_version_of
    <Product> is a signed copy of <RelatedProduct>.
    Is_special_edition_of
    <Product> is a special edition of <RelatedProduct>.
    May_be_substituted_by
    If ordered, <Product> may (at the supplier's discretion) be substituted and the <RelatedProduct> supplied instead (inverse of code 47).
    May_be_substituted_for
    If ordered, <RelatedProduct> may (at the supplier's discretion) be substituted and the <Product> supplied instead (inverse of code 46).
    POD_replacement_for
    <Product> is a POD replacement for <RelatedProduct>.
    Product_by_same_author
    <Product> and <RelatedProduct> have a common author
    Product_in_same_collection
    <RelatedProduct> and <Product> are part of the same collection (eg two products in same series or set) (is own inverse)
    Publishers_suggested_alternative
    <Product> has a publisher's suggested alternative <RelatedProduct>, which does not, however, carry the same content (cf 05 and 06)
    Replaced_by
    <Product> is replaced by, or has new edition, <RelatedProduct> (inverse of code 03)
    Replaced_by_POD
    <Product> is replaced by POD <RelatedProduct>.
    Replaces
    <Product> replaces, or is new edition of, <RelatedProduct> (inverse of code 05)
    Sales_expectation
    Use to give the ISBN of another book that had sales (both in terms of copy numbers and customer profile) comparable to that the publisher or distributor estimates for the product.
    Similar_product
    <RelatedProduct> is another product that is suggested as similar to <Product> ('if you liked <Product>, you may also like <RelatedProduct>', or vice versa)
    Some_content_shared_with
    <Product> includes some content shared with <RelatedProduct>.
    Unspecified
    <Product> is related to <RelatedProduct> in a way that cannot be specified by another code value

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final String
    code
     
    final String
    description
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static ProductRelations
    byCode(String code)
     
    static Optional<ProductRelations>
    byCodeOptional(String code)
     
    static String
    codeToDesciption(String code)
     
    String
    getCode()
     
    String
    getDescription()
     
    static ProductRelations
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ProductRelations[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.tectonica.jonix.common.OnixCodelist

    pair

  • Enum Constant Details

    • Unspecified

      public static final ProductRelations Unspecified
      <Product> is related to <RelatedProduct> in a way that cannot be specified by another code value

    • Includes

      public static final ProductRelations Includes
      <Product> includes <RelatedProduct> (inverse of code 02)

    • Is_part_of

      public static final ProductRelations Is_part_of
      <Product> is part of <RelatedProduct>: use for 'also available as part of' (inverse of code 01)

    • Replaces

      public static final ProductRelations Replaces
      <Product> replaces, or is new edition of, <RelatedProduct> (inverse of code 05)

    • Has_companion_product

      public static final ProductRelations Has_companion_product
      <Product> and <RelatedProduct> are companion products, intended to be used, or are usable, together (is own inverse). Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • Replaced_by

      public static final ProductRelations Replaced_by
      <Product> is replaced by, or has new edition, <RelatedProduct> (inverse of code 03)

    • Alternative_format

      public static final ProductRelations Alternative_format
      <Product> is available in an alternative format as <RelatedProduct> - indicates an alternative format of the same content which is or may be available (is own inverse)

    • Has_ancillary_product

      public static final ProductRelations Has_ancillary_product
      <Product> has an ancillary or supplementary product <RelatedProduct> (inverse of code 08)

    • Is_ancillary_to

      public static final ProductRelations Is_ancillary_to
      <Product> is ancillary or supplementary to <RelatedProduct> (inverse of code 07)

    • Is_remaindered_as

      public static final ProductRelations Is_remaindered_as
      <Product> is remaindered as <RelatedProduct>, when a remainder merchant assigns its own identifier to the product (inverse of code 10)

    • Is_remainder_of

      public static final ProductRelations Is_remainder_of
      <Product> was originally sold as <RelatedProduct>, indicating the publisher's original identifier for a title which is offered as a remainder under a different identifier (inverse of code 09)

    • Is_other_language_version_of

      public static final ProductRelations Is_other_language_version_of
      <Product> is an other-language version of <RelatedProduct> (is own inverse)

    • Publishers_suggested_alternative

      public static final ProductRelations Publishers_suggested_alternative
      <Product> has a publisher's suggested alternative <RelatedProduct>, which does not, however, carry the same content (cf 05 and 06)

    • Epublication_based_on_print_product

      public static final ProductRelations Epublication_based_on_print_product
      <Product> is an epublication based on printed product <RelatedProduct>. The related product is the source of any print-equivalent page numbering present in the epublication (inverse of code 27)

    • POD_replacement_for

      public static final ProductRelations POD_replacement_for
      <Product> is a POD replacement for <RelatedProduct>. <RelatedProduct> is an out-of-print product replaced by a print-on-demand version under a new ISBN (inverse of code 17)

    • Replaced_by_POD

      public static final ProductRelations Replaced_by_POD
      <Product> is replaced by POD <RelatedProduct>. <RelatedProduct> is a print-on-demand replacement, under a new ISBN, for an out-of-print <Product> (inverse of code 16)

    • Is_special_edition_of

      public static final ProductRelations Is_special_edition_of
      <Product> is a special edition of <RelatedProduct>. Used for a special edition (de: 'Sonderausgabe') with different cover, binding, premium content etc - more than 'alternative format' - which may be available in limited quantity and for a limited time (inverse of code 19)

    • Has_special_edition

      public static final ProductRelations Has_special_edition
      <Product> has a special edition <RelatedProduct> (inverse of code 18)

    • Is_prebound_edition_of

      public static final ProductRelations Is_prebound_edition_of
      <Product> is a prebound edition of <RelatedProduct> (In the US, a 'prebound' edition is 'a book that was previously bound and has been rebound with a library quality hardcover binding. In almost all commercial cases, the book in question began as a paperback. This might also be termed 're-bound') (inverse of code 21)

    • Is_original_of_prebound_edition

      public static final ProductRelations Is_original_of_prebound_edition
      <Product> is the regular edition of which <RelatedProduct> is a prebound edition (inverse of code 20)

    • Product_by_same_author

      public static final ProductRelations Product_by_same_author
      <Product> and <RelatedProduct> have a common author

    • Similar_product

      public static final ProductRelations Similar_product
      <RelatedProduct> is another product that is suggested as similar to <Product> ('if you liked <Product>, you may also like <RelatedProduct>', or vice versa)

    • Is_facsimile_of

      public static final ProductRelations Is_facsimile_of
      <Product> is a facsimile edition of <RelatedProduct> (inverse of code 25)

    • Is_original_of_facsimile

      public static final ProductRelations Is_original_of_facsimile
      <Product> is the original edition from which a facsimile edition <RelatedProduct> is taken (inverse of code 24)

    • Is_license_for

      public static final ProductRelations Is_license_for
      <Product> is a license for a digital <RelatedProduct>, traded or supplied separately

    • Electronic_version_available_as

      public static final ProductRelations Electronic_version_available_as
      <RelatedProduct> is an electronic version of print <Product> (inverse of code 13)

    • Enhanced_version_available_as

      public static final ProductRelations Enhanced_version_available_as
      <RelatedProduct> is an 'enhanced' version of <Product>, with additional content. Typically used to link an enhanced e-book to its original 'unenhanced' equivalent, but not specifically limited to linking e-books - for example, may be used to link illustrated and non-illustrated print books. <Product> and <RelatedProduct> should share the same <ProductForm> (inverse of code 29)

    • Basic_version_available_as

      public static final ProductRelations Basic_version_available_as
      <RelatedProduct> is a basic version of <Product>. <Product> and <RelatedProduct> should share the same <ProductForm> (inverse of code 28)

    • Product_in_same_collection

      public static final ProductRelations Product_in_same_collection
      <RelatedProduct> and <Product> are part of the same collection (eg two products in same series or set) (is own inverse)

    • Has_alternative_in_a_different_market_sector

      public static final ProductRelations Has_alternative_in_a_different_market_sector
      <RelatedProduct> is an alternative product in another sector (of the same geographical market). Indicates an alternative that carries the same content, but available to a different set of customers, as one or both products are retailer-, channel- or market sector-specific (is own inverse)

    • Has_equivalent_intended_for_a_different_market

      public static final ProductRelations Has_equivalent_intended_for_a_different_market
      <RelatedProduct> is an equivalent product, often intended for another (geographical) market. Indicates an alternative that carries essentially the same content, though slightly adapted for local circumstances (as opposed to a translation - use code 11) (is own inverse)

    • Has_alternative_intended_for_different_market

      public static final ProductRelations Has_alternative_intended_for_different_market
      <RelatedProduct> is an alternative product, often intended for another (geographical) market. Indicates the content of the alternative is identical in all respects (is own inverse)

    • Cites

      public static final ProductRelations Cites
      <Product> cites <RelatedProduct> (inverse of code 35)

    • Is_cited_by

      public static final ProductRelations Is_cited_by
      <Product> is the object of a citation in <RelatedProduct> (inverse of code 34)

    • Is_signed_version_of

      public static final ProductRelations Is_signed_version_of
      <Product> is a signed copy of <RelatedProduct>. Use where signed copies are given a distinct product identifier and can be ordered separately, but are otherwise identical (inverse of code 38)

    • Has_signed_version

      public static final ProductRelations Has_signed_version
      <Product> is an unsigned copy of <RelatedProduct>. Use where signed copies are given a distinct product identifier and can be ordered separately, but are otherwise identical (inverse of code 37)

    • Some_content_shared_with

      public static final ProductRelations Some_content_shared_with
      <Product> includes some content shared with <RelatedProduct>. Note the shared content does not form the whole of either product. Compare with the 'includes' / 'is part of' relationship pair (codes 01 and 02), where the shared content forms the whole of one of the products, and with the 'alternative format' relationship (code 06), where the shared content forms the whole of both products (code 41 is own inverse)

    • Is_later_edition_of_first_edition

      public static final ProductRelations Is_later_edition_of_first_edition
      <Product> is a later edition of <RelatedProduct>, where the related product is the first edition

    • Adapted_from

      public static final ProductRelations Adapted_from
      <Product> is an adapted (dramatized, abridged, novelized etc) version of <RelatedProduct> (inverse of code 44). Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • Adapted_as

      public static final ProductRelations Adapted_as
      <Product> is the original from which <RelatedProduct> is adapted (dramatized etc) (inverse of code 43). Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • Has_linked_product_offer

      public static final ProductRelations Has_linked_product_offer
      Purchases of <Product> may qualify for one or more copies of <RelatedProduct> either free of charge or at a reduced price (inverse of code 48). This may be dependent on retailer participation, upon price and upon the quantity of the <Product> purchased. Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • May_be_substituted_by

      public static final ProductRelations May_be_substituted_by
      If ordered, <Product> may (at the supplier's discretion) be substituted and the <RelatedProduct> supplied instead (inverse of code 47). Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • May_be_substituted_for

      public static final ProductRelations May_be_substituted_for
      If ordered, <RelatedProduct> may (at the supplier's discretion) be substituted and the <Product> supplied instead (inverse of code 46). Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • Is_linked_product_offer

      public static final ProductRelations Is_linked_product_offer
      Purchases of <RelatedProduct> may qualify for one or more copies of <Product> either free of charge or at a reduced price (inverse of code 45). This may be dependent on retailer participation, upon price and upon the quantity of the <RelatedProduct> purchased. Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • Epublication_is_distributed_as

      public static final ProductRelations Epublication_is_distributed_as
      <Product> is an epublication 'rendered' as <RelatedProduct>: use in ONIX 2.1 only when the <Product> record describes a package of electronic content which is available in multiple 'renderings' (coded 000 in <EpubTypeCode>): NOT USED in ONIX 3.0

      Jonix-Comment: Deprecated in Onix3

    • Epublication_is_a_rendering_of

      public static final ProductRelations Epublication_is_a_rendering_of
      <Product> is a 'rendering' of an epublication <RelatedProduct>: use in ONIX 2.1 only when the <Product> record describes a specific rendering of an epublication content package, to identify the package: NOT USED in ONIX 3.0

      Jonix-Comment: Deprecated in Onix3

    • Sales_expectation

      public static final ProductRelations Sales_expectation
      Use to give the ISBN of another book that had sales (both in terms of copy numbers and customer profile) comparable to that the publisher or distributor estimates for the product. Use in ONIX 2.1 ONLY

      Jonix-Comment: Deprecated in Onix3

  • Field Details

    • code

      public final String code

    • description

      public final String description

  • Method Details

    • values

      public static ProductRelations[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ProductRelations valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getCode

      public String getCode()
      Specified by:
      getCode in interface OnixCodelist

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface OnixCodelist

    • byCode

      public static ProductRelations byCode(String code)

    • byCodeOptional

      public static Optional<ProductRelations> byCodeOptional(String code)

    • codeToDesciption

      public static String codeToDesciption(String code)