Package javax.persistence
Interface TypedQuery<X>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description java.util.List<X>
getResultList()
Execute a SELECT query and return the query results as a typed List.default java.util.stream.Stream<X>
getResultStream()
Execute a SELECT query and return the query results as a typedjava.util.stream.Stream
.X
getSingleResult()
Execute a SELECT query that returns a single result.TypedQuery<X>
setFirstResult(int startPosition)
Set the position of the first result to retrieve.TypedQuery<X>
setFlushMode(FlushModeType flushMode)
Set the flush mode type to be used for the query execution.TypedQuery<X>
setHint(java.lang.String hintName, java.lang.Object value)
Set a query property or hint.TypedQuery<X>
setLockMode(LockModeType lockMode)
Set the lock mode type to be used for the query execution.TypedQuery<X>
setMaxResults(int maxResult)
Set the maximum number of results to retrieve.TypedQuery<X>
setParameter(int position, java.lang.Object value)
Bind an argument value to a positional parameter.TypedQuery<X>
setParameter(int position, java.util.Calendar value, TemporalType temporalType)
Bind an instance ofjava.util.Calendar
to a positional parameter.TypedQuery<X>
setParameter(int position, java.util.Date value, TemporalType temporalType)
Bind an instance ofjava.util.Date
to a positional parameter.TypedQuery<X>
setParameter(java.lang.String name, java.lang.Object value)
Bind an argument value to a named parameter.TypedQuery<X>
setParameter(java.lang.String name, java.util.Calendar value, TemporalType temporalType)
Bind an instance ofjava.util.Calendar
to a named parameter.TypedQuery<X>
setParameter(java.lang.String name, java.util.Date value, TemporalType temporalType)
Bind an instance ofjava.util.Date
to a named parameter.TypedQuery<X>
setParameter(Parameter<java.util.Calendar> param, java.util.Calendar value, TemporalType temporalType)
Bind an instance ofjava.util.Calendar
to aParameter
object.TypedQuery<X>
setParameter(Parameter<java.util.Date> param, java.util.Date value, TemporalType temporalType)
Bind an instance ofjava.util.Date
to aParameter
object.<T> TypedQuery<X>
setParameter(Parameter<T> param, T value)
Bind the value of aParameter
object.-
Methods inherited from interface javax.persistence.Query
executeUpdate, getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrap
-
-
-
-
Method Detail
-
getResultList
java.util.List<X> getResultList()
Execute a SELECT query and return the query results as a typed List.- Specified by:
getResultList
in interfaceQuery
- Returns:
- a list of the results
- Throws:
java.lang.IllegalStateException
- if called for a Java Persistence query language UPDATE or DELETE statementQueryTimeoutException
- if the query execution exceeds the query timeout value set and only the statement is rolled backTransactionRequiredException
- if a lock mode other thanNONE
has been set and there is no transaction or the persistence context has not been joined to the transactionPessimisticLockException
- if pessimistic locking fails and the transaction is rolled backLockTimeoutException
- if pessimistic locking fails and only the statement is rolled backPersistenceException
- if the query execution exceeds the query timeout value set and the transaction is rolled back
-
getResultStream
default java.util.stream.Stream<X> getResultStream()
Execute a SELECT query and return the query results as a typedjava.util.stream.Stream
. By default this method delegates togetResultList().stream()
, however persistence provider may choose to override this method to provide additional capabilities.- Specified by:
getResultStream
in interfaceQuery
- Returns:
- a stream of the results
- Throws:
java.lang.IllegalStateException
- if called for a Java Persistence query language UPDATE or DELETE statementQueryTimeoutException
- if the query execution exceeds the query timeout value set and only the statement is rolled backTransactionRequiredException
- if a lock mode other thanNONE
has been set and there is no transaction or the persistence context has not been joined to the transactionPessimisticLockException
- if pessimistic locking fails and the transaction is rolled backLockTimeoutException
- if pessimistic locking fails and only the statement is rolled backPersistenceException
- if the query execution exceeds the query timeout value set and the transaction is rolled back- Since:
- 2.2
- See Also:
Stream
,getResultList()
-
getSingleResult
X getSingleResult()
Execute a SELECT query that returns a single result.- Specified by:
getSingleResult
in interfaceQuery
- Returns:
- the result
- Throws:
NoResultException
- if there is no resultNonUniqueResultException
- if more than one resultjava.lang.IllegalStateException
- if called for a Java Persistence query language UPDATE or DELETE statementQueryTimeoutException
- if the query execution exceeds the query timeout value set and only the statement is rolled backTransactionRequiredException
- if a lock mode other thanNONE
has been set and there is no transaction or the persistence context has not been joined to the transactionPessimisticLockException
- if pessimistic locking fails and the transaction is rolled backLockTimeoutException
- if pessimistic locking fails and only the statement is rolled backPersistenceException
- if the query execution exceeds the query timeout value set and the transaction is rolled back
-
setMaxResults
TypedQuery<X> setMaxResults(int maxResult)
Set the maximum number of results to retrieve.- Specified by:
setMaxResults
in interfaceQuery
- Parameters:
maxResult
- maximum number of results to retrieve- Returns:
- the same query instance
- Throws:
java.lang.IllegalArgumentException
- if the argument is negative
-
setFirstResult
TypedQuery<X> setFirstResult(int startPosition)
Set the position of the first result to retrieve.- Specified by:
setFirstResult
in interfaceQuery
- Parameters:
startPosition
- position of the first result, numbered from 0- Returns:
- the same query instance
- Throws:
java.lang.IllegalArgumentException
- if the argument is negative
-
setHint
TypedQuery<X> setHint(java.lang.String hintName, java.lang.Object value)
Set a query property or hint. The hints elements may be used to specify query properties and hints. Properties defined by this specification must be observed by the provider. Vendor-specific hints that are not recognized by a provider must be 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, this hint may or may not be observed.
-
setParameter
<T> TypedQuery<X> setParameter(Parameter<T> param, T value)
Bind the value of aParameter
object.- Specified by:
setParameter
in interfaceQuery
- Parameters:
param
- parameter objectvalue
- parameter value- Returns:
- the same query instance
- Throws:
java.lang.IllegalArgumentException
- if the parameter does not correspond to a parameter of the query
-
setParameter
TypedQuery<X> setParameter(Parameter<java.util.Calendar> param, java.util.Calendar value, TemporalType temporalType)
Bind an instance ofjava.util.Calendar
to aParameter
object.- Specified by:
setParameter
in interfaceQuery
- Parameters:
param
- parameter objectvalue
- parameter valuetemporalType
- temporal type- Returns:
- the same query instance
- Throws:
java.lang.IllegalArgumentException
- if the parameter does not correspond to a parameter of the query
-
setParameter
TypedQuery<X> setParameter(Parameter<java.util.Date> param, java.util.Date value, TemporalType temporalType)
Bind an instance ofjava.util.Date
to aParameter
object.- Specified by:
setParameter
in interfaceQuery
- Parameters:
param
- parameter objectvalue
- parameter valuetemporalType
- temporal type- Returns:
- the same query instance
- Throws:
java.lang.IllegalArgumentException
- if the parameter does not correspond to a parameter of the query
-
setParameter
TypedQuery<X> setParameter(java.lang.String name, java.lang.Object value)
Bind an argument value to a named parameter.- Specified by:
setParameter
in interfaceQuery
- Parameters:
name
- parameter namevalue
- parameter value- Returns:
- the same query instance
- Throws:
java.lang.IllegalArgumentException
- if the parameter name does not correspond to a parameter of the query or if the argument is of incorrect type
-
setParameter
TypedQuery<X> setParameter(java.lang.String name, java.util.Calendar value, TemporalType temporalType)
Bind an instance ofjava.util.Calendar
to a named parameter.- Specified by:
setParameter
in interfaceQuery
- Parameters:
name
- parameter namevalue
- parameter valuetemporalType
- temporal type- Returns:
- the same query instance
- Throws:
java.lang.IllegalArgumentException
- if the parameter name does not correspond to a parameter of the query or if the value argument is of incorrect type
-
setParameter
TypedQuery<X> setParameter(java.lang.String name, java.util.Date value, TemporalType temporalType)
Bind an instance ofjava.util.Date
to a named parameter.- Specified by:
setParameter
in interfaceQuery
- Parameters:
name
- parameter namevalue
- parameter valuetemporalType
- temporal type- Returns:
- the same query instance
- Throws:
java.lang.IllegalArgumentException
- if the parameter name does not correspond to a parameter of the query or if the value argument is of incorrect type
-
setParameter
TypedQuery<X> setParameter(int position, java.lang.Object value)
Bind an argument value to a positional parameter.- Specified by:
setParameter
in interfaceQuery
- Parameters:
position
- positionvalue
- parameter value- Returns:
- the same query instance
- Throws:
java.lang.IllegalArgumentException
- if position does not correspond to a positional parameter of the query or if the argument is of incorrect type
-
setParameter
TypedQuery<X> setParameter(int position, java.util.Calendar value, TemporalType temporalType)
Bind an instance ofjava.util.Calendar
to a positional parameter.- Specified by:
setParameter
in interfaceQuery
- Parameters:
position
- positionvalue
- parameter valuetemporalType
- temporal type- Returns:
- the same query instance
- Throws:
java.lang.IllegalArgumentException
- if position does not correspond to a positional parameter of the query or if the value argument is of incorrect type
-
setParameter
TypedQuery<X> setParameter(int position, java.util.Date value, TemporalType temporalType)
Bind an instance ofjava.util.Date
to a positional parameter.- Specified by:
setParameter
in interfaceQuery
- Parameters:
position
- positionvalue
- parameter valuetemporalType
- temporal type- Returns:
- the same query instance
- Throws:
java.lang.IllegalArgumentException
- if position does not correspond to a positional parameter of the query or if the value argument is of incorrect type
-
setFlushMode
TypedQuery<X> 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.- Specified by:
setFlushMode
in interfaceQuery
- Parameters:
flushMode
- flush mode- Returns:
- the same query instance
-
setLockMode
TypedQuery<X> setLockMode(LockModeType lockMode)
Set the lock mode type to be used for the query execution.- Specified by:
setLockMode
in interfaceQuery
- Parameters:
lockMode
- lock mode- Returns:
- the same query instance
- Throws:
java.lang.IllegalStateException
- if the query is found not to be a Jakarta Persistence query language SELECT query or a CriteriaQuery query
-
-