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

Enum Class NotificationOrUpdateTypes

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

Description: Notification or update type

See Also:

  • Enum Constant Details

    • Early_notification

      public static final NotificationOrUpdateTypes Early_notification
      Use for a complete record issued earlier than approximately six months before publication

    • Advance_notification_confirmed

      public static final NotificationOrUpdateTypes Advance_notification_confirmed
      Use for a complete record issued to confirm advance information approximately six months before publication; or for a complete record issued after that date and before information has been confirmed from the book-in-hand

    • Notification_confirmed_on_publication

      public static final NotificationOrUpdateTypes Notification_confirmed_on_publication
      Use for a complete record issued to confirm advance information at or just before actual publication date, usually from the book-in-hand, or for a complete record issued at any later date

    • Update_partial

      public static final NotificationOrUpdateTypes Update_partial
      In ONIX 3.0 or later only, use when sending a 'block update' record. A block update implies using the supplied block(s) to update the existing record for the product, replacing only the blocks included in the block update, and leaving other blocks unchanged - for example, replacing old information from Blocks 4 and 6 with the newly-received data while retaining information from Blocks 1-3, 5 and 7-8 untouched. In previous ONIX releases, and for ONIX 3.0 or later using other notification types, updating is by replacing the complete record with the newly-received data

    • Delete

      public static final NotificationOrUpdateTypes Delete
      Use when sending an instruction to delete a record which was previously issued. Note that a Delete instruction should NOT be used when a product is cancelled, put out of print, or otherwise withdrawn from sale: this should be handled as a change of Publishing status, leaving the receiver to decide whether to retain or delete the record. A Delete instruction is used ONLY when there is a particular reason to withdraw a record completely, eg because it was issued in error

    • Notice_of_sale

      public static final NotificationOrUpdateTypes Notice_of_sale
      Notice of sale of a product, from one publisher to another: sent by the publisher disposing of the product

    • Notice_of_acquisition

      public static final NotificationOrUpdateTypes Notice_of_acquisition
      Notice of acquisition of a product, by one publisher from another: sent by the acquiring publisher

    • Test_update_Partial

      public static final NotificationOrUpdateTypes Test_update_Partial
      Only for use in ONIX 3.0 or later. Record may be processed for test purposes, but data should be discarded when testing is complete. Sender must ensure the <RecordReference> matches a previously-sent Test record

    • Test_record

      public static final NotificationOrUpdateTypes Test_record
      Record may be processed for test purposes, but data should be discarded when testing is complete. Sender must ensure the <RecordReference> does not match any previously-sent live product record

    • Update_SupplyDetail_only

      public static final NotificationOrUpdateTypes Update_SupplyDetail_only
      ONIX Books 2.1 supply update - <SupplyDetail> only (not used in ONIX 3.0)

      Jonix-Comment: Deprecated in Onix3

    • Update_MarketRepresentation_only

      public static final NotificationOrUpdateTypes Update_MarketRepresentation_only
      ONIX Books 2.1 supply update - <MarketRepresentation> only (not used in ONIX 3.0)

      Jonix-Comment: Deprecated in Onix3

    • Update_SupplyDetail_and_MarketRepresentation

      public static final NotificationOrUpdateTypes Update_SupplyDetail_and_MarketRepresentation
      ONIX Books 2.1 supply update - both <SupplyDetail> and <MarketRepresentation> (not used in ONIX 3.0)

      Jonix-Comment: Deprecated in Onix3

  • Field Details

    • code

      public final String code

    • description

      public final String description

  • Method Details

    • values

      public static NotificationOrUpdateTypes[] 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 NotificationOrUpdateTypes 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 NotificationOrUpdateTypes byCode(String code)

    • byCodeOptional

      public static Optional<NotificationOrUpdateTypes> byCodeOptional(String code)

    • codeToDesciption

      public static String codeToDesciption(String code)