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

Enum Class UnitOfUsages

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

Description: Unit of usage

See Also:

  • Enum Constant Details

    • Copies

      public static final UnitOfUsages Copies
      Maximum number of copies that may be made of a permitted extract

    • Characters

      public static final UnitOfUsages Characters
      Maximum number of characters in a permitted extract for a specified usage

    • Words

      public static final UnitOfUsages Words
      Maximum number of words in a permitted extract for a specified usage

    • Pages

      public static final UnitOfUsages Pages
      Maximum number of pages in a permitted extract for a specified usage

    • Percentage

      public static final UnitOfUsages Percentage
      Maximum percentage of total content in a permitted extract for a specified usage

    • Devices

      public static final UnitOfUsages Devices
      Maximum number of devices in 'share group'

    • Concurrent_users

      public static final UnitOfUsages Concurrent_users
      Maximum number of concurrent users. NB where the number of concurrent users is specifically not limited, set the number of concurrent users to zero

    • Users

      public static final UnitOfUsages Users
      Maximum number of licensed individual users, independent of concurrency of use

      Jonix-Comment: Introduced in Onix3

    • Concurrent_classes

      public static final UnitOfUsages Concurrent_classes
      Maximum number of licensed concurrent classes of user. A 'class' is a group of learners attending a specific course or lesson and generally taught as a group

      Jonix-Comment: Introduced in Onix3

    • Classes

      public static final UnitOfUsages Classes
      Maximum number of licensed classes of learners, independent of concurrency of use and the number of users per class

      Jonix-Comment: Introduced in Onix3

    • Institutions

      public static final UnitOfUsages Institutions
      Maximum number of licensed institutions, independend of concurrency of use and the number of classes or individuals per institution

      Jonix-Comment: Introduced in Onix3

    • Percentage_per_time_period

      public static final UnitOfUsages Percentage_per_time_period
      Maximum percentage of total content which may be used in a specified usage per time period; the time period being specified as another <EpubUsageLimit> Quantity

    • Days

      public static final UnitOfUsages Days
      Maximum time period in days (beginning from product purchase or activation)

    • Weeks

      public static final UnitOfUsages Weeks
      Maximum time period in weeks

    • Months

      public static final UnitOfUsages Months
      Maximum time period in months

    • Hours_minutes_and_seconds

      public static final UnitOfUsages Hours_minutes_and_seconds
      Maximum amount of time in hours, minutes and seconds allowed in a permitted extract for a specified usage, in the format HHHMMSS (7 digits, with leading zeros if necessary)

      Jonix-Comment: Introduced in Onix3

    • Days_fixed_start

      public static final UnitOfUsages Days_fixed_start
      Maximum time period in days (beginning from the product publication date). In effect, this defines a fixed end date for the license independent of the purchase or activation date

    • Weeks_fixed_start

      public static final UnitOfUsages Weeks_fixed_start
      Maximum time period in weeks

    • Months_fixed_start

      public static final UnitOfUsages Months_fixed_start
      Maximum time period in months

    • Times

      public static final UnitOfUsages Times
      Maximum number of times a specified usage event may occur (in the lifetime of the product)

    • Times_per_day

      public static final UnitOfUsages Times_per_day
      Maximum frequency a specified usage event may occur (per day)

    • Times_per_month

      public static final UnitOfUsages Times_per_month
      Maximum frequency a specified usage event may occur (per month)

    • Times_per_year

      public static final UnitOfUsages Times_per_year
      Maximum frequency a specified usage event may occur (per year)

    • Dots_per_inch

      public static final UnitOfUsages Dots_per_inch
      Maximum resolution of printed or copy/pasted extracts

    • Dots_per_cm

      public static final UnitOfUsages Dots_per_cm
      Maximum resolution of printed or copy/pasted extracts

    • Allowed_usage_start_page

      public static final UnitOfUsages Allowed_usage_start_page
      Page number where allowed usage begins. <Quantity> should contain an absolute page number, counting the cover as page 1. (This type of page numbering should not be used where the e-publication has no fixed pagination). Use with (max number of) Pages, Percentage of content, or End page to specify pages allowed in Preview

    • Allowed_usage_end_page

      public static final UnitOfUsages Allowed_usage_end_page
      Page number at which allowed usage ends. <Quantity> should contain an absolute page number, counting the cover as page 1. (This type of page numbering should not be used where the e-publication has no fixed pagination). Use with Start page to specify pages allowed in a preview

    • Allowed_usage_start_time

      public static final UnitOfUsages Allowed_usage_start_time
      Time at which allowed usage begins. <Quantity> should contain an absolute time, counting from the beginning of an audio or video product, in the format HHHMMSS or HHHMMSScc. Use with Time, Percentage of content, or End time to specify time-based extract allowed in Preview

      Jonix-Comment: Introduced in Onix3

    • Allowed_usage_end_time

      public static final UnitOfUsages Allowed_usage_end_time
      Time at which allowed usage ends. <Quantity> should contain an absolute time, counting from the beginning of an audio or video product, in the format HHHMMSS or HHHMMSScc. Use with Start time to specify time-based extract allowed in Preview

      Jonix-Comment: Introduced in Onix3

    • Valid_from

      public static final UnitOfUsages Valid_from
      The date from which the usage constraint applies. <Quantity> is in the format YYYYMMDD

      Jonix-Comment: Introduced in Onix3

    • Valid_to

      public static final UnitOfUsages Valid_to
      The date until which the usage constraint applies. <Quantity> is in the format YYYYMMDD

      Jonix-Comment: Introduced in Onix3

  • Field Details

    • code

      public final String code

    • description

      public final String description

  • Method Details

    • values

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

    • byCodeOptional

      public static Optional<UnitOfUsages> byCodeOptional(String code)

    • codeToDesciption

      public static String codeToDesciption(String code)