javax.persistence.TypedQuery Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-jpa-2.0-api Show documentation
Show all versions of hibernate-jpa-2.0-api Show documentation
Hibernate definition of the Java Persistence 2.0 (JSR 317) API.
// $Id:$
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.persistence;
import java.util.List;
import java.util.Date;
import java.util.Calendar;
/**
* Interface used to control the execution of typed queries.
*
* @param query result type
* @see Query
* @see Parameter
* @since Java Persistence 2.0
*/
public interface TypedQuery extends Query {
/**
* Execute a SELECT query and return the query results
* as a typed List.
*
* @return a list of the results
*
* @throws IllegalStateException if called for a Java
* Persistence query language UPDATE or DELETE statement
* @throws QueryTimeoutException if the query execution exceeds
* the query timeout value set and only the statement is
* rolled back
* @throws TransactionRequiredException if a lock mode has
* been set and there is no transaction
* @throws PessimisticLockException if pessimistic locking
* fails and the transaction is rolled back
* @throws LockTimeoutException if pessimistic locking
* fails and only the statement is rolled back
* @throws PersistenceException if the query execution exceeds
* the query timeout value set and the transaction
* is rolled back
*/
List getResultList();
/**
* Execute a SELECT query that returns a single result.
*
* @return the result
*
* @throws NoResultException if there is no result
* @throws NonUniqueResultException if more than one result
* @throws IllegalStateException if called for a Java
* Persistence query language UPDATE or DELETE statement
* @throws QueryTimeoutException if the query execution exceeds
* the query timeout value set and only the statement is
* rolled back
* @throws TransactionRequiredException if a lock mode has
* been set and there is no transaction
* @throws PessimisticLockException if pessimistic locking
* fails and the transaction is rolled back
* @throws LockTimeoutException if pessimistic locking
* fails and only the statement is rolled back
* @throws PersistenceException if the query execution exceeds
* the query timeout value set and the transaction
* is rolled back
*/
X getSingleResult();
/**
* Set the maximum number of results to retrieve.
*
* @param maxResult maximum number of results to retrieve
*
* @return the same query instance
*
* @throws IllegalArgumentException if the argument is negative
*/
TypedQuery setMaxResults(int maxResult);
/**
* Set the position of the first result to retrieve.
*
* @param startPosition position of the first result,
* numbered from 0
*
* @return the same query instance
*
* @throws IllegalArgumentException if the argument is negative
*/
TypedQuery setFirstResult(int startPosition);
/**
* 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.
*
* @param hintName name of property or hint
* @param value value for the property or hint
*
* @return the same query instance
*
* @throws IllegalArgumentException if the second argument is not
* valid for the implementation
*/
TypedQuery setHint(String hintName, Object value);
/**
* Bind the value of a Parameter object.
*
* @param param parameter object
* @param value parameter value
*
* @return the same query instance
*
* @throws IllegalArgumentException if the parameter
* does not correspond to a parameter of the
* query
*/
TypedQuery setParameter(Parameter param, T value);
/**
* Bind an instance of java.util.Calendar to a Parameter object.
*
* @param param parameter object
* @param value parameter value
* @param temporalType temporal type
*
* @return the same query instance
*
* @throws IllegalArgumentException if the parameter does not
* correspond to a parameter of the query
*/
TypedQuery setParameter(Parameter param,
Calendar value,
TemporalType temporalType);
/**
* Bind an instance of java.util.Date to a Parameter object.
*
* @param param parameter object
* @param value parameter value
* @param temporalType temporal type
*
* @return the same query instance
*
* @throws IllegalArgumentException if the parameter does not
* correspond to a parameter of the query
*/
TypedQuery setParameter(Parameter param, Date value,
TemporalType temporalType);
/**
* Bind an argument to a named parameter.
*
* @param name parameter name
* @param value parameter value
*
* @return the same query instance
*
* @throws IllegalArgumentException if the parameter name does
* not correspond to a parameter of the query or if
* the argument is of incorrect type
*/
TypedQuery setParameter(String name, Object value);
/**
* Bind an instance of java.util.Calendar to a named parameter.
*
* @param name parameter name
* @param value parameter value
* @param temporalType temporal type
*
* @return the same query instance
*
* @throws IllegalArgumentException if the parameter name does
* not correspond to a parameter of the query or if
* the value argument is of incorrect type
*/
TypedQuery setParameter(String name, Calendar value,
TemporalType temporalType);
/**
* Bind an instance of java.util.Date to a named parameter.
*
* @param name parameter name
* @param value parameter value
* @param temporalType temporal type
*
* @return the same query instance
*
* @throws IllegalArgumentException if the parameter name does
* not correspond to a parameter of the query or if
* the value argument is of incorrect type
*/
TypedQuery setParameter(String name, Date value,
TemporalType temporalType);
/**
* Bind an argument to a positional parameter.
*
* @param position position
* @param value parameter value
*
* @return 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
*/
TypedQuery setParameter(int position, Object value);
/**
* Bind an instance of java.util.Calendar to a positional
* parameter.
*
* @param position position
* @param value parameter value
* @param temporalType temporal type
*
* @return the same query instance
*
* @throws IllegalArgumentException if position does not
* correspond to a positional parameter of the query
* or if the value argument is of incorrect type
*/
TypedQuery setParameter(int position, Calendar value,
TemporalType temporalType);
/**
* Bind an instance of java.util.Date to a positional parameter.
*
* @param position position
* @param value parameter value
* @param temporalType temporal type
*
* @return the same query instance
*
* @throws IllegalArgumentException if position does not
* correspond to a positional parameter of the query
* or if the value argument is of incorrect type
*/
TypedQuery setParameter(int position, Date value,
TemporalType temporalType);
/**
* 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.
*
* @param flushMode flush mode
*
* @return the same query instance
*/
TypedQuery setFlushMode(FlushModeType flushMode);
/**
* Set the lock mode type to be used for the query execution.
*
* @param lockMode lock mode
*
* @return the same query instance
*
* @throws IllegalStateException if the query is found not to
* be a Java Persistence query language SELECT query
* or a Criteria API query
*/
TypedQuery setLockMode(LockModeType lockMode);
}