Package org.eclipse.persistence.jpa

Interface JpaQuery<X>

All Superinterfaces:
jakarta.persistence.Query, jakarta.persistence.TypedQuery<X>
public interface JpaQuery<X> extends jakarta.persistence.TypedQuery<X>
PUBLIC: EclipseLInk specific JPA query interface. Provides the functionality defined in jakarta.persistence.Query and adds access to the underlying database query for EclipseLink specific functionality.

  • Method Summary

    Modifier and Type
    Method
    Description
    DatabaseQuery
    getDatabaseQuery()
    PUBLIC: Return the cached database query for this query.
    JpaEntityManager
    getEntityManager()
    PUBLIC: return the EntityManager for this query
    Collection
    getResultCollection()
    PUBLIC: Non-standard method to return results of a ReadQuery that has a containerPolicy that returns objects as a collection rather than a List
    Cursor
    getResultCursor()
    PUBLIC: Non-standard method to return results of a ReadQuery that uses a Cursor.
    void
    setDatabaseQuery(DatabaseQuery query)
    PUBLIC: Replace the cached query with the given query.

    Methods inherited from interface jakarta.persistence.Query

    executeUpdate, getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrap

    Methods inherited from interface jakarta.persistence.TypedQuery

    getResultList, getResultStream, getSingleResult, setFirstResult, setFlushMode, setHint, setLockMode, setMaxResults, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter

  • Method Details

    • getDatabaseQuery

      DatabaseQuery getDatabaseQuery()
      PUBLIC: Return the cached database query for this query. If the query is a named query and it has not yet been looked up, the query will be looked up and stored as the cached query.

    • getEntityManager

      JpaEntityManager getEntityManager()
      PUBLIC: return the EntityManager for this query

    • getResultCollection

      Collection getResultCollection()
      PUBLIC: Non-standard method to return results of a ReadQuery that has a containerPolicy that returns objects as a collection rather than a List
      Returns:
      Collection of results

    • getResultCursor

      Cursor getResultCursor()
      PUBLIC: Non-standard method to return results of a ReadQuery that uses a Cursor.
      Returns:
      Cursor on results, either a CursoredStream, or ScrollableCursor

    • setDatabaseQuery

      void setDatabaseQuery(DatabaseQuery query)
      PUBLIC: Replace the cached query with the given query.