com.atlassian.confluence.api.impl.pagination

Interface PaginationQuery<F,T>

All Known Implementing Classes:

PaginationQueryImpl

public interface PaginationQuery<F,T>

Enclosing type for the parameters generally required when dealing with a pagination request from the database.

This interface is not fit for public consumption, as it addresses dealing with underlying database models, something public consumers should never ever be concerned about.

Method Summary

Modifier and Type	Method and Description
com.google.common.base.Function<F,T>	getModelConverter()
List<com.google.common.base.Predicate<F>>	getPredicates()
PaginationQuery<F,T>	withModelConverter(com.google.common.base.Function<F,T> modelConverter) Specifies the model converter Function that should be applied to results.
PaginationQuery<F,T>	withPredicate(com.google.common.base.Predicate<F> predicate) Adds a Predicate used to filter the raw database type results.

Method Detail

withPredicate

PaginationQuery<F,T> withPredicate(com.google.common.base.Predicate<F> predicate)

Adds a Predicate used to filter the raw database type results. Predicates are additive and combined with an AND boolean operation.

NOTE: for now, Predicates *should not* be treated as a Query DSL. These Predicates should only be used to perform filtering of database results that cannot be expressed in a database query proper.

withModelConverter

PaginationQuery<F,T> withModelConverter(com.google.common.base.Function<F,T> modelConverter)

Specifies the model converter Function that should be applied to results. For efficiency, models are only converted once they satisfy all Predicates.

getPredicates

List<com.google.common.base.Predicate<F>> getPredicates()

getModelConverter

com.google.common.base.Function<F,T> getModelConverter()