Contains information about a field from an entity class. Used as part of query criteria construction through Builder, produced by function getField. The constructor should not be invoked manually.

GenericQueryCriteria

interface GenericQueryCriteria<Q : GenericQueryCriteria<Q, *>, in P : BaseQueryCriteriaParser<Q, *, *>>

IQueryCriteriaParser

@DoNotImplement

interface IQueryCriteriaParser : BaseQueryCriteriaParser<QueryCriteria, IQueryCriteriaParser, Sort>

LikenessOperator

enum LikenessOperator : Enum<LikenessOperator> , Operator

NullOperator

enum NullOperator : Enum<NullOperator> , Operator

Operator

@DoNotImplement

interface Operator

PageSpecification

data class PageSpecification(val pageNumber: Int = -1, val pageSize: Int = DEFAULT_PAGE_SIZE)

PageSpecification allows specification of a page number (starting from DEFAULT_PAGE_NUM) and page size (defaulting to DEFAULT_PAGE_SIZE with a maximum page size of MAX_PAGE_SIZE) Note: we default the page number to DEFAULT_PAGE_SIZE to enable queries without requiring a page specification but enabling detection of large results sets that fall out of the DEFAULT_PAGE_SIZE requirement. MAX_PAGE_SIZE should be used with extreme caution as results may exceed your JVM memory footprint.

QueryCriteria

sealed class QueryCriteria : GenericQueryCriteria<QueryCriteria, IQueryCriteriaParser> , GenericQueryCriteria.ChainableQueryCriteria<QueryCriteria, IQueryCriteriaParser>

Indexing assumptions: QueryCriteria assumes underlying schema tables are correctly indexed for performance.

SessionScope

@DoNotImplement

interface SessionScope

Represents scope for the operation when JPA Session been created, i.e. transaction started.

Sort

data class Sort(val columns: Collection<Sort.SortColumn>) : BaseSort

Sort allows specification of a set of entity attribute names and their associated directionality and null handling, to be applied upon processing a query specification.

SortAttribute

sealed class SortAttribute