org.kiwiproject.search.PaginatedResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kiwi Show documentation

Kiwi is a utility library. We really like Google's Guava, and also use Apache Commons. But if they don't have something we need, and we think it is useful, this is where we put it.

There is a newer version: 4.5.2

Show newest version

package org.kiwiproject.search;

/**
 * Simple interface defining basic pagination for any kind of search, e.g. a database query, SOLR search, etc.
 */
public interface PaginatedResult {

    /**
     * The total number of results, though a {@link PaginatedResult} instance will contain only a subset of the total.
     *
     * @return total number of results
     */
    long getTotalCount();

    /**
     * The page number of this result. Can be used in both zero- and one-based page numbering schemes as long
     * as it is used consistently, e.g. the server and clients are both using one-based page numbering.
     *
     * @return the page number
     */
    int getPageNumber();

    /**
     * The page size being used to paginate the search results.
     *
     * @return the page size
     */
    int getPageSize();
}