Interface KeysetPageableConfiguration
- All Superinterfaces:
PageableConfiguration
- Since:
- 1.2.0
- Author:
- Christian Beikov
-
Method Summary
Modifier and TypeMethodDescriptionReturns the pageable to fall back to when no page configuration is given.Returns the name of the query parameter to use for the highest keyset.Returns the name of the query parameter to use for the lowest keyset.Returns the name of the query parameter to use for the previous offset.Returns the name of the query parameter to use for the previous page.Returns the name of the query parameter to use for the previous page size.voidsetFallbackPageable(KeysetPageable fallbackPageable) Sets the pageable to use when no page configuration is given.voidsetHighestParameterName(String highestParameterName) Sets the name of the query parameter that should be used to extract the highest keyset value.voidsetLowestParameterName(String lowestParameterName) Sets the name of the query parameter that should be used to extract the lowest keyset value.voidsetPreviousOffsetParameterName(String previousOffsetParameterName) Sets the name of the query parameter that should be used to extract the previous offset value.voidsetPreviousPageParameterName(String previousPageParameterName) Sets the name of the query parameter that should be used to extract the previous page value.voidsetPreviousSizeParameterName(String previousSizeParameterName) Sets the name of the query parameter that should be used to extract the previous page size value.Methods inherited from interface com.blazebit.persistence.deltaspike.data.rest.PageableConfiguration
getMaxPageSize, getOffsetParameterName, getPageParameterName, getPrefix, getSizeParameterName, getSortParameterName, isOneIndexedParameters, setFallbackPageable, setMaxPageSize, setOffsetParameterName, setOneIndexedParameters, setPageParameterName, setPrefix, setSizeParameterName, setSortParameterName
-
Method Details
-
getFallbackPageable
KeysetPageable getFallbackPageable()Description copied from interface:PageableConfigurationReturns the pageable to fall back to when no page configuration is given.- Specified by:
getFallbackPageablein interfacePageableConfiguration- Returns:
- The fallback pageable
-
setFallbackPageable
Sets the pageable to use when no page configuration is given.- Parameters:
fallbackPageable- The fallback pageable
-
getPreviousOffsetParameterName
String getPreviousOffsetParameterName()Returns the name of the query parameter to use for the previous offset.- Returns:
- The query parameter name for the previous offset
- Since:
- 1.3.0
-
setPreviousOffsetParameterName
Sets the name of the query parameter that should be used to extract the previous offset value.- Parameters:
previousOffsetParameterName- The query parameter name for the previous offset- Since:
- 1.3.0
-
getPreviousPageParameterName
String getPreviousPageParameterName()Returns the name of the query parameter to use for the previous page.- Returns:
- The query parameter name for the previous page
-
setPreviousPageParameterName
Sets the name of the query parameter that should be used to extract the previous page value.- Parameters:
previousPageParameterName- The query parameter name for the previous page
-
getPreviousSizeParameterName
String getPreviousSizeParameterName()Returns the name of the query parameter to use for the previous page size.- Returns:
- The query parameter name for the previous page size
-
setPreviousSizeParameterName
Sets the name of the query parameter that should be used to extract the previous page size value.- Parameters:
previousSizeParameterName- The query parameter name for the previous page size
-
getLowestParameterName
String getLowestParameterName()Returns the name of the query parameter to use for the lowest keyset.- Returns:
- The query parameter name for the lowest keyset
-
setLowestParameterName
Sets the name of the query parameter that should be used to extract the lowest keyset value.- Parameters:
lowestParameterName- The query parameter name for the lowest keyset
-
getHighestParameterName
String getHighestParameterName()Returns the name of the query parameter to use for the highest keyset.- Returns:
- The query parameter name for the highest keyset
-
setHighestParameterName
Sets the name of the query parameter that should be used to extract the highest keyset value.- Parameters:
highestParameterName- The query parameter name for the highest keyset
-