|
EclipseLink 2.0.0, build 'v20091127-r5931' API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
X
- query result typepublic interface TypedQuery<X>
Interface used to control the execution of typed queries.
Query
,
Parameter
Method Summary | ||
---|---|---|
java.util.List<X> |
getResultList()
Execute a SELECT query and return the query results as a typed List. |
|
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.util.Calendar value,
TemporalType temporalType)
Bind an instance of java.util.Calendar to a positional
parameter. |
|
TypedQuery<X> |
setParameter(int position,
java.util.Date value,
TemporalType temporalType)
Bind an instance of java.util.Date to a positional parameter. |
|
TypedQuery<X> |
setParameter(int position,
java.lang.Object value)
Bind an argument to a positional parameter. |
|
TypedQuery<X> |
setParameter(Parameter<java.util.Calendar> param,
java.util.Calendar value,
TemporalType temporalType)
Bind an instance of java.util.Calendar to a Parameter object. |
|
TypedQuery<X> |
setParameter(Parameter<java.util.Date> param,
java.util.Date value,
TemporalType temporalType)
Bind an instance of java.util.Date to a Parameter object. |
|
|
setParameter(Parameter<T> param,
T value)
Bind the value of a Parameter object. |
|
TypedQuery<X> |
setParameter(java.lang.String name,
java.util.Calendar value,
TemporalType temporalType)
Bind an instance of java.util.Calendar to a named parameter. |
|
TypedQuery<X> |
setParameter(java.lang.String name,
java.util.Date value,
TemporalType temporalType)
Bind an instance of java.util.Date to a named parameter. |
|
TypedQuery<X> |
setParameter(java.lang.String name,
java.lang.Object value)
Bind an argument to a named parameter. |
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 |
---|
java.util.List<X> getResultList()
getResultList
in interface Query
java.lang.IllegalStateException
- if called for a Java
Persistence query language UPDATE or DELETE statement
QueryTimeoutException
- if the query execution exceeds
the query timeout value set and only the statement is
rolled back
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
PersistenceException
- if the query execution exceeds
the query timeout value set and the transaction
is rolled backX getSingleResult()
getSingleResult
in interface Query
NoResultException
- if there is no result
NonUniqueResultException
- if more than one result
java.lang.IllegalStateException
- if called for a Java
Persistence query language UPDATE or DELETE statement
QueryTimeoutException
- if the query execution exceeds
the query timeout value set and only the statement is
rolled back
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
PersistenceException
- if the query execution exceeds
the query timeout value set and the transaction
is rolled backTypedQuery<X> setMaxResults(int maxResult)
setMaxResults
in interface Query
maxResult
- maximum number of results to retrieve
java.lang.IllegalArgumentException
- if the argument is negativeTypedQuery<X> setFirstResult(int startPosition)
setFirstResult
in interface Query
startPosition
- position of the first result,
numbered from 0
java.lang.IllegalArgumentException
- if the argument is negativeTypedQuery<X> setHint(java.lang.String hintName, java.lang.Object value)
setHint
in interface Query
hintName
- name of property or hintvalue
- value for the property or hint
java.lang.IllegalArgumentException
- if the second argument is not
valid for the implementation<T> TypedQuery<X> setParameter(Parameter<T> param, T value)
Parameter
object.
setParameter
in interface Query
param
- parameter objectvalue
- parameter value
java.lang.IllegalArgumentException
- if the parameter
does not correspond to a parameter of the
queryTypedQuery<X> setParameter(Parameter<java.util.Calendar> param, java.util.Calendar value, TemporalType temporalType)
java.util.Calendar
to a Parameter
object.
setParameter
in interface Query
param
- parameter objectvalue
- parameter valuetemporalType
- temporal type
java.lang.IllegalArgumentException
- if the parameter does not
correspond to a parameter of the queryTypedQuery<X> setParameter(Parameter<java.util.Date> param, java.util.Date value, TemporalType temporalType)
java.util.Date
to a Parameter
object.
setParameter
in interface Query
param
- parameter objectvalue
- parameter valuetemporalType
- temporal type
java.lang.IllegalArgumentException
- if the parameter does not
correspond to a parameter of the queryTypedQuery<X> setParameter(java.lang.String name, java.lang.Object value)
setParameter
in interface Query
name
- parameter namevalue
- parameter value
java.lang.IllegalArgumentException
- if the parameter name does
not correspond to a parameter of the query or if
the argument is of incorrect typeTypedQuery<X> setParameter(java.lang.String name, java.util.Calendar value, TemporalType temporalType)
java.util.Calendar
to a named parameter.
setParameter
in interface Query
name
- parameter namevalue
- parameter valuetemporalType
- temporal type
java.lang.IllegalArgumentException
- if the parameter name does
not correspond to a parameter of the query or if
the value argument is of incorrect typeTypedQuery<X> setParameter(java.lang.String name, java.util.Date value, TemporalType temporalType)
java.util.Date
to a named parameter.
setParameter
in interface Query
name
- parameter namevalue
- parameter valuetemporalType
- temporal type
java.lang.IllegalArgumentException
- if the parameter name does
not correspond to a parameter of the query or if
the value argument is of incorrect typeTypedQuery<X> setParameter(int position, java.lang.Object value)
setParameter
in interface Query
position
- positionvalue
- parameter value
java.lang.IllegalArgumentException
- if position does not
correspond to a positional parameter of the
query or if the argument is of incorrect typeTypedQuery<X> setParameter(int position, java.util.Calendar value, TemporalType temporalType)
java.util.Calendar
to a positional
parameter.
setParameter
in interface Query
position
- positionvalue
- parameter valuetemporalType
- temporal type
java.lang.IllegalArgumentException
- if position does not
correspond to a positional parameter of the query
or if the value argument is of incorrect typeTypedQuery<X> setParameter(int position, java.util.Date value, TemporalType temporalType)
java.util.Date
to a positional parameter.
setParameter
in interface Query
position
- positionvalue
- parameter valuetemporalType
- temporal type
java.lang.IllegalArgumentException
- if position does not
correspond to a positional parameter of the query
or if the value argument is of incorrect typeTypedQuery<X> setFlushMode(FlushModeType flushMode)
setFlushMode
in interface Query
flushMode
- flush mode
TypedQuery<X> setLockMode(LockModeType lockMode)
setLockMode
in interface Query
lockMode
- lock mode
java.lang.IllegalStateException
- if the query is found not to
be a Java Persistence query language SELECT query
or a Criteria API query
|
EclipseLink 2.0.0, build 'v20091127-r5931' API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |