javax.persistence
Interface Query

public interface Query

Interface used to control query execution.

Method Summary

int	executeUpdate() Execute an update or delete statement.
int	getFirstResult() The position of the first result the query object was set to retrieve.
FlushModeType	getFlushMode() The flush mode in effect for the query execution.
Map<String,Object>	getHints() Get the hints and associated values that are in effect for the query instance.
LockModeType	getLockMode() Get the current lock mode for the query.
int	getMaxResults() The maximum number of results the query object was set to retrieve.
Map<String,Object>	getNamedParameters() Get the parameters names and associated values of the parameters that are bound for the query instance.
List	getPositionalParameters() Get the values of the positional parameters that are bound for the query instance.
List	getResultList() Execute a SELECT query and return the query results as a List.
Object	getSingleResult() Execute a SELECT query that returns a single result.
Set<String>	getSupportedHints() Get the names of the hints that are supported for query objects.
Query	setFirstResult(int startPosition) Set the position of the first result to retrieve.
Query	setFlushMode(FlushModeType flushMode) Set the flush mode type to be used for the query execution.
Query	setHint(String hintName, Object value) Set a query hint.
Query	setLockMode(LockModeType lockMode) Set the lock mode type to be used for the query execution.
Query	setMaxResults(int maxResult) Set the maximum number of results to retrieve.
Query	setParameter(int position, Calendar value, TemporalType temporalType) Bind an instance of java.util.Calendar to a positional parameter.
Query	setParameter(int position, Date value, TemporalType temporalType) Bind an instance of java.util.Date to a positional parameter.
Query	setParameter(int position, Object value) Bind an argument to a positional parameter.
Query	setParameter(String name, Calendar value, TemporalType temporalType) Bind an instance of java.util.Calendar to a named parameter.
Query	setParameter(String name, Date value, TemporalType temporalType) Bind an instance of java.util.Date to a named parameter.
Query	setParameter(String name, Object value) Bind an argument to a named parameter.
<T> T	unwrap(Class<T> cls) Return an object of the specified type to allow access to the provider-specific API.

Method Detail

getResultList

List getResultList()

Execute a SELECT query and return the query results as a List.

Returns:

a list of the results

Throws:

IllegalStateException - if called for a Java Persistence query language UPDATE or DELETE statement

QueryTimeoutException - if the query execution exceeds the query timeout value set

TransactionRequiredException - if a lock mode has been set and there is no transaction

PessimisticLockException - if pessimistic locking fails and the transaction is rolled back

LockTimeoutException - if pessimistic locking fails and only the statement is rolled back

getSingleResult

Object getSingleResult()

Execute a SELECT query that returns a single result.

Returns:

the result

Throws:

NoResultException - if there is no result

NonUniqueResultException - if more than one result

IllegalStateException - if called for a Java Persistence query language UPDATE or DELETE statement

QueryTimeoutException - if the query execution exceeds *the query timeout value set

TransactionRequiredException - if a lock mode has been set and there is no transaction

PessimisticLockException - if pessimistic locking fails and the transaction is rolled back

LockTimeoutException - if pessimistic locking fails and only the statement is rolled back

executeUpdate

int executeUpdate()

Execute an update or delete statement.

Returns:

the number of entities updated or deleted

Throws:

IllegalStateException - if called for a Java Persistence query language SELECT statement or for a criteria query

TransactionRequiredException - if there is no transaction

QueryTimeoutException - if the statement execution exceeds the query timeout value set

setMaxResults

Query setMaxResults(int maxResult)

Set the maximum number of results to retrieve.

Parameters:

maxResult -

Returns:

the same query instance

Throws:

IllegalArgumentException - if argument is negative

getMaxResults

int getMaxResults()

The maximum number of results the query object was set to retrieve. Returns Integer.MAX_VALUE if setMaxResults was not applied to the query object.

Returns:

maximum number of results

setFirstResult

Query setFirstResult(int startPosition)

Set the position of the first result to retrieve.

Parameters:

startPosition - position of the first result, numbered from 0

Returns:

the same query instance

Throws:

IllegalArgumentException - if argument is negative

getFirstResult

int getFirstResult()

The position of the first result the query object was set to retrieve. Returns 0 if setFirstResult was not applied to the query object.

Returns:

position of first result

setHint

Query setHint(String hintName,
              Object value)

Set a query hint. If a vendor-specific hint is not recognized, it is silently ignored. Portable applications should not rely on the standard timeout hint. Depending on the database in use and the locking mechanisms used by the provider, the hint may or may not be observed. * @param hintName

Parameters:

value -

Returns:

the same query instance

Throws:

IllegalArgumentException - if the second argument is not valid for the implementation

getHints

Map<String,Object> getHints()

Get the hints and associated values that are in effect for the query instance.

Returns:

query hints

getSupportedHints

Set<String> getSupportedHints()

Get the names of the hints that are supported for query objects. These hints correspond to hints that may be passed to the methods of the Query interface that take hints as arguments or used with the NamedQuery and NamedNativeQuery annotations. These include all standard query hints as well as vendor-specific hints supported by the provider. These hints may or may not currently be in effect.

Returns:

hints

setParameter

Query setParameter(String name,
                   Object value)

Bind an argument to a named parameter.

Parameters:

name - the parameter name

value -

Returns:

the same query instance

Throws:

IllegalArgumentException - if parameter name does not correspond to a parameter of the query or if the argument is of incorrect type

setParameter

Query setParameter(String name,
                   Date value,
                   TemporalType temporalType)

Bind an instance of java.util.Date to a named parameter.

Parameters:

name -

value -

temporalType -

Returns:

the same query instance

Throws:

IllegalArgumentException - if parameter name does not correspond to a parameter of the query

setParameter

Query setParameter(String name,
                   Calendar value,
                   TemporalType temporalType)

Bind an instance of java.util.Calendar to a named parameter.

Parameters:

name -

value -

temporalType -

Returns:

the same query instance

Throws:

IllegalArgumentException - if parameter name does not correspond to a parameter of the query

setParameter

Query setParameter(int position,
                   Object value)

Bind an argument to a positional parameter.

Parameters:

position -

value -

Returns:

the same query instance

Throws:

IllegalArgumentException - if position does not correspond to a positional parameter of the query or if the argument is of incorrect type

setParameter

Query setParameter(int position,
                   Date value,
                   TemporalType temporalType)

Bind an instance of java.util.Date to a positional parameter.

Parameters:

position -

value -

temporalType -

Returns:

the same query instance

Throws:

IllegalArgumentException - if position does not correspond to a positional parameter of the query

setParameter

Query setParameter(int position,
                   Calendar value,
                   TemporalType temporalType)

Bind an instance of java.util.Calendar to a positional parameter.

Parameters:

position -

value -

temporalType -

Returns:

the same query instance

Throws:

IllegalArgumentException - if position does not correspond to a positional parameter of the *query

getNamedParameters

Map<String,Object> getNamedParameters()

Get the parameters names and associated values of the parameters that are bound for the query instance. Returns empty map if no parameters have been bound or if the query does not use named parameters.

Returns:

named parameters

getPositionalParameters

List getPositionalParameters()

Get the values of the positional parameters that are bound for the query instance. Positional parameters are listed in order of position. Returns empty list if no parameters have been bound or if the query does not use positional parameters.

Returns:

positional parameters

setFlushMode

Query setFlushMode(FlushModeType flushMode)

Set the flush mode type to be used for the query execution. The flush mode type applies to the query regardless of the flush mode type in use for the entity manager.

Parameters:

flushMode -

getFlushMode

FlushModeType getFlushMode()

The flush mode in effect for the query execution. If a flush mode has not been set for the query object, returns the flush mode in effect for the entity manager.

Returns:

flush mode

setLockMode

Query setLockMode(LockModeType lockMode)

Set the lock mode type to be used for the query execution.

Parameters:

lockMode -

Throws:

IllegalStateException - if the query is found not to be *a Java Persistence query language SELECT query or a Criteria API query

getLockMode

LockModeType getLockMode()

Get the current lock mode for the query.

Returns:

lock mode

Throws:

IllegalStateException - if the query is found not to be *a Java Persistence query language SELECT query or a Criteria API query

unwrap

<T> T unwrap(Class<T> cls)

Return an object of the specified type to allow access to the provider-specific API. If the provider's Query implementation does not support the specified class, the PersistenceException is thrown.

Parameters:

cls - the class of the object to be returned. This is normally either the underlying Query implementation class or an interface that it implements.

Returns:

an instance of the specified class

Throws:

PersistenceException - if the provider does not support the call.