Top Description Methods
org.eclipse.persistence.jpa

public Interface JpaQuery<X>

extends TypedQuery<X>
Known Direct Implementers
org.eclipse.persistence.internal.jpa.EJBQueryImpl
Imports
java.util.Collection, org.eclipse.persistence.queries.Cursor, .DatabaseQuery

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 TypeMethod and Description
public DatabaseQuery
getDatabaseQuery()

PUBLIC: Return the cached database query for this query.

public JpaEntityManager
getEntityManager()

PUBLIC: return the EntityManager for this query

public Collection<E>

Returns:

Collection of results
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

public Cursor

Returns:

Cursor on results, either a CursoredStream, or ScrollableCursor
getResultCursor
()

PUBLIC: Non-standard method to return results of a ReadQuery that uses a Cursor.

public void
setDatabaseQuery(DatabaseQuery query)

PUBLIC: Replace the cached query with the given query.

Inherited from jakarta.persistence.TypedQuery:
getResultListgetResultStreamgetSingleResultsetFirstResultsetFlushModesetHintsetLockModesetMaxResultssetParametersetParametersetParametersetParametersetParametersetParametersetParametersetParametersetParameter

Method Detail

getDatabaseQueryback to summary
public 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.

getEntityManagerback to summary
public JpaEntityManager getEntityManager()

PUBLIC: return the EntityManager for this query

getResultCollectionback to summary
public Collection<E> 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<E>

Collection of results

getResultCursorback to summary
public Cursor getResultCursor()

PUBLIC: Non-standard method to return results of a ReadQuery that uses a Cursor.

Returns:Cursor

Cursor on results, either a CursoredStream, or ScrollableCursor

setDatabaseQueryback to summary
public void setDatabaseQuery(DatabaseQuery query)

PUBLIC: Replace the cached query with the given query.