Enum Class PaginationStrategy

java.lang.Object
java.lang.Enum<PaginationStrategy>
oracle.dbtools.plugin.api.pagination.PaginationStrategy
All Implemented Interfaces:
Serializable, Comparable<PaginationStrategy>, Constable

public enum PaginationStrategy extends Enum<PaginationStrategy>
The type of pagination strategy used by a resource.
Author:
cdivilly
  • Enum Constant Details

    • NONE

      public static final PaginationStrategy NONE
      The resource is not paginated by ORDS. It may be paginated by the servlet itself
    • ITEM_OFFSET

      public static final PaginationStrategy ITEM_OFFSET
      The resource is paginated by identifying the offset of the first item to include in the page. This is the default strategy and the one specified by the Oracle REST Services Standard.
    • PAGE_OFFSET

      public static final PaginationStrategy PAGE_OFFSET
      The resource is paginated by a page offset. This is the legacy pagination strategy used in earlier versions of the product.
    • NOT_PAGINATED

      public static final PaginationStrategy NOT_PAGINATED
      The resource is explicitly not paginated. Presence of pagination parameters in the request query string indicate an error.
    • RESULT_SET_PAGINATION

      public static final PaginationStrategy RESULT_SET_PAGINATION
      The resource is not paginated by modifying the query, instead the query is executed as is , but the number of rows returned is limited to the number specified by the limit
  • Method Details

    • values

      public static PaginationStrategy[] 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 PaginationStrategy 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
    • paginated

      public static boolean paginated(PaginationStrategy pagination)
      Test if a Pagination Strategy requires pagination
      Parameters:
      pagination - The strategy to test
      Returns:
      true if the resource is paginated