Interface PagedQuery<E>

Type Parameters:
E - The entity type
All Superinterfaces:
io.micronaut.core.annotation.AnnotationMetadataProvider, io.micronaut.core.annotation.AnnotationSource, io.micronaut.core.naming.Named
All Known Subinterfaces:
BindableParametersPreparedQuery<E,R>, DelegatePreparedQuery<E,R>, MongoPreparedQuery<E,R>, PreparedQuery<E,R>, SqlPreparedQuery<E,R>
All Known Implementing Classes:
DefaultBindableParametersPreparedQuery, DefaultPagedQuery, DefaultPreparedQuery, DefaultSqlPreparedQuery, DummyPreparedQuery
public interface PagedQuery<E> extends io.micronaut.core.naming.Named, io.micronaut.core.annotation.AnnotationMetadataProvider
Object passed to queries for pagination requests.
Since:
1.0.0
Author:
graemerocher

  • Field Summary

    Fields inherited from interface io.micronaut.core.annotation.AnnotationSource

    EMPTY

  • Method Summary

    Modifier and Type
    Method
    Description
    Pageable
    getPageable()
     
    default Map<String,Object>
    getQueryHints()
    The parameter binding.
    default Limit
    getQueryLimit()
     
    Class<E>
    getRootEntity()
    The root entity type.
    default Sort
    getSort()
     

    Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadataProvider

    findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, getAnnotationMetadata, getTargetAnnotationMetadata, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

    Methods inherited from interface io.micronaut.core.annotation.AnnotationSource

    getAnnotation, getAnnotation, getDeclaredAnnotation, getDeclaredAnnotation, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeDeclared

    Methods inherited from interface io.micronaut.core.naming.Named

    getName

  • Method Details

    • getRootEntity

      Class<E> getRootEntity()
      The root entity type.
      Returns:
      The root entity type

    • getPageable

      Pageable getPageable()
      Returns:
      The pageable object. Defaults to Pageable.UNPAGED

    • getQueryLimit

      default Limit getQueryLimit()
      Returns:
      The limit
      Since:
      4.13

    • getSort

      default Sort getSort()
      Returns:
      The sort
      Since:
      4.13

    • getQueryHints

      default Map<String,Object> getQueryHints()
      The parameter binding. That is the mapping between named query parameters and parameters of the method.
      Returns:
      The parameter binding.