Interface Stage.SelectionQuery<R>

    • Method Detail

      • setMaxResults

        Stage.SelectionQuery<R> setMaxResults​(int maxResults)
        Set the maximum number of results that may be returned by this query when executed.
      • setFirstResult

        Stage.SelectionQuery<R> setFirstResult​(int firstResult)
        Set the position of the first result that may be returned by this query when executed, where the results are numbered from 0.
      • getMaxResults

        int getMaxResults()
        Returns:
        the maximum number results, or Integer.MAX_VALUE if not set
      • getFirstResult

        int getFirstResult()
        Returns:
        the first result, or 0 if not set
      • getSingleResult

        CompletionStage<R> getSingleResult()
        Asynchronously execute this query, returning a single row that matches the query, throwing an exception if the query returns zero rows or more than one matching row. If the query has multiple results per row, the results are returned in an instance of Object[].
        Returns:
        the single resulting row
        Throws:
        jakarta.persistence.NoResultException - if there is no result
        jakarta.persistence.NonUniqueResultException - if there are multiple results
        See Also:
        Query.getSingleResult()
      • getSingleResultOrNull

        CompletionStage<R> getSingleResultOrNull()
        Asynchronously execute this query, returning a single row that matches the query, or null if the query returns no results, throwing an exception if the query returns more than one matching row. If the query has multiple results per row, the results are returned in an instance of Object[].
        Returns:
        the single resulting row or null
        Throws:
        jakarta.persistence.NonUniqueResultException - if there are multiple results
        See Also:
        getSingleResult()
      • getResultList

        CompletionStage<List<R>> getResultList()
        Asynchronously execute this query, returning the query results as a List, via a CompletionStage. If the query has multiple results per row, the results are returned in an instance of Object[].
        Returns:
        the resulting rows as a List
        See Also:
        Query.getResultList()
      • setCacheable

        Stage.SelectionQuery<R> setCacheable​(boolean cacheable)
        Enable or disable caching of this query result set in the second-level query cache.
        Parameters:
        cacheable - true if this query is cacheable
      • isCacheable

        boolean isCacheable()
        Returns:
        true if this query is cacheable
        See Also:
        setCacheable(boolean)
      • setCacheRegion

        Stage.SelectionQuery<R> setCacheRegion​(String cacheRegion)
        Set the name of the cache region in which to store this query result set if caching is enabled.
        Parameters:
        cacheRegion - the name of the cache region
      • setCacheStoreMode

        default Stage.SelectionQuery<R> setCacheStoreMode​(jakarta.persistence.CacheStoreMode cacheStoreMode)
        Set the current CacheStoreMode in effect while this query is being executed.
      • setCacheRetrieveMode

        default Stage.SelectionQuery<R> setCacheRetrieveMode​(jakarta.persistence.CacheRetrieveMode cacheRetrieveMode)
        Set the current CacheRetrieveMode in effect while this query is being executed.
      • getCacheStoreMode

        jakarta.persistence.CacheStoreMode getCacheStoreMode()
      • getCacheRetrieveMode

        jakarta.persistence.CacheRetrieveMode getCacheRetrieveMode()
      • setFlushMode

        default Stage.SelectionQuery<R> setFlushMode​(jakarta.persistence.FlushModeType flushModeType)
        Set the current FlushModeType in effect while this query is being executed.
      • setLockMode

        default Stage.SelectionQuery<R> setLockMode​(jakarta.persistence.LockModeType lockModeType)
        Set the LockModeType to use for the whole query.
      • setLockMode

        default Stage.SelectionQuery<R> setLockMode​(String alias,
                                                    jakarta.persistence.LockModeType lockModeType)
        Set the LockModeType to use for specified alias (as defined in the query's from clause).
        Parameters:
        alias - the from clause alias
        lockModeType - the requested LockModeType
        See Also:
        Query.setLockMode(String,LockMode)
      • setPlan

        Stage.SelectionQuery<R> setPlan​(jakarta.persistence.EntityGraph<R> entityGraph)
        Set the EntityGraph that will be used as a fetch plan for the root entity returned by this query.
      • setParameter

        Stage.SelectionQuery<R> setParameter​(int parameter,
                                             Object argument)
        Description copied from interface: Stage.AbstractQuery
        Set the value of an ordinal parameter. Ordinal parameters are numbered from 1, and are specified in the query using placeholder tokens of form ?1, ?2, etc.
        Specified by:
        setParameter in interface Stage.AbstractQuery
        Parameters:
        parameter - an integer identifying the ordinal parameter
        argument - the argument to set