PageFilterResult

data class PageFilterResult(name: String, hits: List<<ERROR CLASS><out <ERROR CLASS>>>, totalHits: Long, page: Int, perPage: Int, totalPages: Int, from: Int, size: Int) : FilterResult, Iterable<<ERROR CLASS><out <ERROR CLASS>>>

PageFilterResult holds result of a PageFilter.

Parameters

name

name of a PageFilter

hits

list of hits on the current page

totalHits

total number of hits

page

number of the current page

perPage

number of hits per page

totalPages

total number of pages

from

value applied to SearchQuery.from

size

value applied to SearchQuery.size

Constructors

PageFilterResult

fun PageFilterResult(name: String, hits: List<<ERROR CLASS><out <ERROR CLASS>>>, totalHits: Long, page: Int, perPage: Int, totalPages: Int, from: Int, size: Int)

name of a PageFilter

Functions

iterator

open operator override fun iterator(): Iterator<<ERROR CLASS><out <ERROR CLASS>>>

Properties

from

value applied to SearchQuery.from

hits

val hits: List<<ERROR CLASS><out <ERROR CLASS>>>

list of hits on the current page

name

open override val name: String

name of a PageFilter

page

number of the current page

perPage

val perPage: Int

number of hits per page

size

value applied to SearchQuery.size

totalHits

val totalHits: Long

total number of hits

totalPages

val totalPages: Int

total number of pages