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

Enum Class UsageTypes

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

Description: Usage type

See Also:

  • Enum Constant Details

    • No_constraints

      public static final UsageTypes No_constraints
      Allows positive indication that there are no particular constraints (that can be specifed in <EpubUsageConstraint>). By convention, use 01 in <EpubUsageStatus>

      Jonix-Comment: Introduced in Onix3

    • Preview

      public static final UsageTypes Preview
      Preview before purchase. Allows a retail customer, account holder or patron to view or listen to a proportion of the book before purchase. Also applies to borrowers making use of 'acquisition on demand' models in libraries, and to 'subscription' models where the purchase is made on behalf of the reader

    • Print

      public static final UsageTypes Print
      Print paper copy of extract

    • Copy_paste

      public static final UsageTypes Copy_paste
      Make digital copy of extract

    • Share

      public static final UsageTypes Share
      Share product across multiple concurrent devices. Allows a retail customer, account holder or patron to read the book across multiple devices linked to the same account. Also applies to readers in library borrowing and 'subscription' models

    • Text_to_speech

      public static final UsageTypes Text_to_speech
      'Read aloud' with text to speech functionality

    • Lend

      public static final UsageTypes Lend
      Lendable by the purchaser to other device owner or account holder or patron, eg 'Lend-to-a-friend', library lending (where the library product has a separate <ProductIdentifier> from the consumer product). The 'primary' copy becomes unusable while the secondary copy is 'on loan' unless a number of concurrent borrowers is also specified

    • Time_limited_license

      public static final UsageTypes Time_limited_license
      E-publication license is time-limited. Use with code 02 from List 146 and either a time period in days, weeks or months in <EpubUsageLimit>, or a Valid until date in <EpubUsageLimit>. The purchased copy becomes unusable when the license expires. For clarity, a perpetual license is the default, but may be specified explicitly with code 01 from list 146, or with code 02 and a limit <Quantity> of 0 days

    • Loan_renewal

      public static final UsageTypes Loan_renewal
      Maximum number of consecutive loans or loan extensions (eg from a library) to a single device owner or account holder. Note that a limit of 1 indicates that a loan cannot be renewed or extended

    • Multi_user_license

      public static final UsageTypes Multi_user_license
      E-publication license is multi-user. Maximum number of concurrent users licensed to use the product should be given in <EpubUsageLimit>. For clarity, unlimited concurrencyis the default, but may be specified explicitly with code 01 from list 146, or with code 02 and a limit <Quantity> of 0 users

    • Preview_on_premises

      public static final UsageTypes Preview_on_premises
      Preview locally before purchase. Allows a retail customer, account holder or patron to view a proportion of the book (or the whole book, if no proportion is specified) before purchase, but ONLY while located physically in the retailer's store (eg while logged on to the store or library wifi). Also applies to patrons making use of 'acquisition on demand' models in libraries

      Jonix-Comment: Introduced in Onix3

    • Text_and_data_mining

      public static final UsageTypes Text_and_data_mining
      Make use of the content of the product (text, images, audio etc) for extraction of useful (and possibly new) information through automated computer analysis. By convention, use 01 or 03 in <EpubUsageStatus>. Note 03 should be regarded as 'prohibited to the full extent allowed by law', or otherwise expressly reserved by the rightsholder, as in some jurisdictions, TDM may be subject to copyright exception (eg for not-for-profit purposes), subject to optional reservation, or allowed under 'fair use' doctrine

      Jonix-Comment: Introduced in Onix3

  • Field Details

    • code

      public final String code

    • description

      public final String description

  • Method Details

    • values

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

    • byCodeOptional

      public static Optional<UsageTypes> byCodeOptional(String code)

    • codeToDesciption

      public static String codeToDesciption(String code)