Enum Class PaginationStrategy
- All Implemented Interfaces:
Serializable,Comparable<PaginationStrategy>,Constable
The type of pagination strategy used by a resource.
- Author:
- cdivilly
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe resource is paginated by identifying the offset of the first item to include in the page.The resource is not paginated by ORDS.The resource is explicitly not paginated.The resource is paginated by a page offset.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 Summary
Modifier and TypeMethodDescriptionstatic booleanpaginated(PaginationStrategy pagination) Test if a Pagination Strategy requires paginationstatic PaginationStrategyReturns the enum constant of this class with the specified name.static PaginationStrategy[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NONE
The resource is not paginated by ORDS. It may be paginated by the servlet itself -
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
The resource is paginated by a page offset. This is the legacy pagination strategy used in earlier versions of the product. -
NOT_PAGINATED
The resource is explicitly not paginated. Presence of pagination parameters in the request query string indicate an error. -
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
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
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 nameNullPointerException- if the argument is null
-
paginated
Test if a Pagination Strategy requires pagination- Parameters:
pagination- The strategy to test- Returns:
- true if the resource is paginated
-