[hibernate-commits] Hibernate SVN: r11225 - branches/Branch_3_2/HibernateExt/jpa-api/src/javax/persistence.

Author: epbernard Date: 2007-02-20 15:55:29 -0500 (Tue, 20 Feb 2007) New Revision: 11225 Modified: branches/Branch_3_2/HibernateExt/jpa-api/src/javax/persistence/Query.java Log: JavaDoc fixing Modified: branches/Branch_3_2/HibernateExt/jpa-api/src/javax/persistence/Query.java =================================================================== --- branches/Branch_3_2/HibernateExt/jpa-api/src/javax/persistence/Query.java 2007-02-20 19:39:48 UTC (rev 11224) +++ branches/Branch_3_2/HibernateExt/jpa-api/src/javax/persistence/Query.java 2007-02-20 20:55:29 UTC (rev 11225) @@ -9,138 +9,140 @@ /** * Interface used to control query execution. */ -public interface Query { - /** - * Execute the query and return the query results as a List. - * - * @return a list of the results - * @throws IllegalStateException f called for a Java Persistence query language UPDATE or DELETE statement - */ - public List getResultList(); +public interface Query +{ + /** + * Execute the query and return the query results as a List. + * + * @return a list of the results + * @throws IllegalStateException f called for a Java Persistence query language UPDATE or DELETE statement + */ + public List getResultList(); - /** - * Execute a query that returns a single result. - * - * @return the result - * @throws EntityNotFoundException if there is no result - * @throws NonUniqueResultException if more than one resul - * @throws IllegalStateException f called for a Java Persistence query language UPDATE or DELETE statement - */ - public Object getSingleResult(); + /** + * 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 + */ + public Object getSingleResult(); - /** - * Execute an update or delete statement. - * - * @return the number of entities updated or deleted - * @throws IllegalStateException if called for a Java Persistence query language SELECT statement - * @throws TransactionRequiredException if there is no transaction - */ - public int executeUpdate(); + /** + * Execute an update or delete statement. + * + * @return the number of entities updated or deleted + * @throws IllegalStateException if called for a Java Persistence query language SELECT statement + * @throws TransactionRequiredException if there is no transaction + */ + public int executeUpdate(); - /** - * Set the maximum number of results to retrieve. - * - * @param maxResult - * @return the same query instance - * @throws IllegalArgumentException if argument is negative - */ - public Query setMaxResults(int maxResult); + /** + * Set the maximum number of results to retrieve. + * + * @param maxResult + * @return the same query instance + * @throws IllegalArgumentException if argument is negative + */ + public Query 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 argument is negative - */ - public Query setFirstResult(int startPosition); + /** + * 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 argument is negative + */ + public Query setFirstResult(int startPosition); - /** - * Set an implementation-specific hint. If the hint name is not recognized, it is silently - * ignored. - * - * @param hintName - * @param value - * @return the same query instance - * @throws IllegalArgumentException if the second argument is not valid for the implementation - */ - public Query setHint(String hintName, Object value); + /** + * Set an implementation-specific hint. If the hint name is not recognized, it is silently + * ignored. + * + * @param hintName + * @param value + * @return the same query instance + * @throws IllegalArgumentException if the second argument is not valid for the implementation + */ + public Query setHint(String hintName, Object value); - /** - * Bind an argument to a named parameter. - * - * @param name the parameter name - * @param value - * @return the same query instance - * @throws IllegalArgumentException if parameter name does not correspond to parameter in query - * string or argument is of incorrect type - */ - public Query setParameter(String name, Object value); + /** + * Bind an argument to a named parameter. + * + * @param name the parameter name + * @param value + * @return the same query instance + * @throws IllegalArgumentException if parameter name does not correspond to parameter in query + * string or argument is of incorrect type + */ + public Query setParameter(String name, Object value); - /** - * Bind an instance of java.util.Date to a named parameter. - * - * @param name - * @param value - * @param temporalType - * @return the same query instance - * @throws IllegalArgumentException if parameter name does not correspond to parameter in query - * string - */ - public Query setParameter(String name, Date value, TemporalType temporalType); + /** + * Bind an instance of java.util.Date to a named parameter. + * + * @param name + * @param value + * @param temporalType + * @return the same query instance + * @throws IllegalArgumentException if parameter name does not correspond to parameter in query + * string + */ + public Query setParameter(String name, Date value, TemporalType temporalType); - /** - * Bind an instance of java.util.Calendar to a named parameter. - * - * @param name - * @param value - * @param temporalType - * @return the same query instance - * @throws IllegalArgumentException if parameter name does not correspond to parameter in query - * string - */ - public Query setParameter(String name, Calendar value, TemporalType temporalType); + /** + * Bind an instance of java.util.Calendar to a named parameter. + * + * @param name + * @param value + * @param temporalType + * @return the same query instance + * @throws IllegalArgumentException if parameter name does not correspond to parameter in query + * string + */ + public Query setParameter(String name, Calendar value, TemporalType temporalType); - /** - * Bind an argument to a positional parameter. - * - * @param position - * @param value - * @return the same query instance - * @throws IllegalArgumentException if position does not correspond to positional parameter of - * query or argument is of incorrect type - */ - public Query setParameter(int position, Object value); + /** + * Bind an argument to a positional parameter. + * + * @param position + * @param value + * @return the same query instance + * @throws IllegalArgumentException if position does not correspond to positional parameter of + * query or argument is of incorrect type + */ + public Query setParameter(int position, Object value); - /** - * Bind an instance of java.util.Date to a positional parameter. - * - * @param position - * @param value - * @param temporalType - * @return the same query instance - * @throws IllegalArgumentException if position does not correspond to positional parameter of - * query - */ - public Query setParameter(int position, Date value, TemporalType temporalType); + /** + * Bind an instance of java.util.Date to a positional parameter. + * + * @param position + * @param value + * @param temporalType + * @return the same query instance + * @throws IllegalArgumentException if position does not correspond to positional parameter of + * query + */ + public Query setParameter(int position, Date value, TemporalType temporalType); - /** - * Bind an instance of java.util.Calendar to a positional parameter. - * - * @param position - * @param value - * @param temporalType - * @return the same query instance } correspond to positional parameter of query - */ - public Query setParameter(int position, Calendar value, TemporalType temporalType); + /** + * Bind an instance of java.util.Calendar to a positional parameter. + * + * @param position + * @param value + * @param temporalType + * @return the same query instance } correspond to positional parameter of query + */ + public Query setParameter(int position, Calendar 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 - */ - public 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. + * + * @param flushMode + */ + public Query setFlushMode(FlushModeType flushMode); } \ No newline at end of file