Package io.micronaut.data.model.runtime

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:
    DelegatePreparedQuery<E,​R>, MongoPreparedQuery<E,​R,​Dtb>, PreparedQuery<E,​R>, SqlPreparedQuery<E,​R>
    All Known Implementing Classes:
    DefaultPagedQuery, DefaultPreparedQuery
    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

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      Pageable getPageable()  
      default java.util.Map<java.lang.String,​java.lang.Object> getQueryHints()
      The parameter binding.
      java.lang.Class<E> getRootEntity()
      The root entity type.

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

        findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, getAnnotationMetadata, 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 Detail

      • getRootEntity

        @NonNull
java.lang.Class<E> getRootEntity()
        The root entity type.
        Returns:
        The root entity type

      • getQueryHints

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