Viaduct JavaAPI API/viaduct.java.api.types/BackwardConnectionArguments

BackwardConnectionArguments

interface BackwardConnectionArguments : ConnectionArguments(source)

Arguments for backward pagination through a connection.

Java equivalent of Kotlin's viaduct.api.types.BackwardConnectionArguments. The math and validation are delegated to the language-neutral ConnectionArgumentsSupport shared with the Kotlin Tenant API.

See also

Inheritors

Functions

Link copied to clipboard
abstract fun getBefore(): String
Cursor to start fetching items before (exclusive); null to start from the end.
Link copied to clipboard
abstract fun getLast(): Integer
Maximum number of items to return from the end; null for the default page size.
Link copied to clipboard
open fun requiresTotalCountForOffsetLimit(): Boolean
Returns true if backward pagination needs the total count to resolve the starting offset.
Link copied to clipboard
open fun toOffsetLimit(defaultPageSize: Int): OffsetLimit
Converts backward pagination arguments to offset/limit.
open fun toOffsetLimit(totalCount: Int, defaultPageSize: Int): OffsetLimit
Converts backward pagination arguments to offset/limit when the total count is known.
Link copied to clipboard
open fun validate()
Validates backward pagination arguments.