001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036: package javax.persistence;
037:
038: import java.util.Calendar;
039: import java.util.Date;
040: import java.util.List;
041:
042: /**
043: * Interface used to control query execution.
044: *
045: * @since Java Persistence 1.0
046: */
047: public interface Query {
048:
049: /**
050: * Execute a SELECT query and return the query results
051: * as a List.
052: * @return a list of the results
053: * @throws IllegalStateException if called for a Java
054: * Persistence query language UPDATE or DELETE statement
055: */
056: public List getResultList();
057:
058: /**
059: * Execute a SELECT query that returns a single result.
060: * @return the result
061: * @throws NoResultException if there is no result
062: * @throws NonUniqueResultException if more than one result
063: * @throws IllegalStateException if called for a Java
064: * Persistence query language UPDATE or DELETE statement
065: */
066: public Object getSingleResult();
067:
068: /**
069: * Execute an update or delete statement.
070: * @return the number of entities updated or deleted
071: * @throws IllegalStateException if called for a Java
072: * Persistence query language SELECT statement
073: * @throws TransactionRequiredException if there is
074: * no transaction
075: */
076: public int executeUpdate();
077:
078: /**
079: * Set the maximum number of results to retrieve.
080: * @param maxResult
081: * @return the same query instance
082: * @throws IllegalArgumentException if argument is negative
083: */
084: public Query setMaxResults(int maxResult);
085:
086: /**
087: * Set the position of the first result to retrieve.
088: * @param startPosition the start position of the first result, numbered from 0
089: * @return the same query instance
090: * @throws IllegalArgumentException if argument is negative
091: */
092: public Query setFirstResult(int startPosition);
093:
094: /**
095: * Set an implementation-specific hint.
096: * If the hint name is not recognized, it is silently ignored.
097: * @param hintName
098: * @param value
099: * @return the same query instance
100: * @throws IllegalArgumentException if the second argument is not
101: * valid for the implementation
102: */
103: public Query setHint(String hintName, Object value);
104:
105: /**
106: * Bind an argument to a named parameter.
107: * @param name the parameter name
108: * @param value
109: * @return the same query instance
110: * @throws IllegalArgumentException if parameter name does not
111: * correspond to parameter in query string
112: * or argument is of incorrect type
113: */
114: public Query setParameter(String name, Object value);
115:
116: /**
117: * Bind an instance of java.util.Date to a named parameter.
118: * @param name
119: * @param value
120: * @param temporalType
121: * @return the same query instance
122: * @throws IllegalArgumentException if parameter name does not
123: * correspond to parameter in query string
124: */
125: public Query setParameter(String name, Date value,
126: TemporalType temporalType);
127:
128: /**
129: * Bind an instance of java.util.Calendar to a named parameter.
130: * @param name
131: * @param value
132: * @param temporalType
133: * @return the same query instance
134: * @throws IllegalArgumentException if parameter name does not
135: * correspond to parameter in query string
136: */
137: public Query setParameter(String name, Calendar value,
138: TemporalType temporalType);
139:
140: /**
141: * Bind an argument to a positional parameter.
142: * @param position
143: * @param value
144: * @return the same query instance
145: * @throws IllegalArgumentException if position does not
146: * correspond to positional parameter of query
147: * or argument is of incorrect type
148: */
149: public Query setParameter(int position, Object value);
150:
151: /**
152: * Bind an instance of java.util.Date to a positional parameter.
153: * @param position
154: * @param value
155: * @param temporalType
156: * @return the same query instance
157: * @throws IllegalArgumentException if position does not
158: * correspond to positional parameter of query
159: */
160: public Query setParameter(int position, Date value,
161: TemporalType temporalType);
162:
163: /**
164: * Bind an instance of java.util.Calendar to a positional parameter.
165: * @param position
166: * @param value
167: * @param temporalType
168: * @return the same query instance
169: * @throws IllegalArgumentException if position does not
170: * correspond to positional parameter of query
171: */
172: public Query setParameter(int position, Calendar value,
173: TemporalType temporalType);
174:
175: /**
176: * Set the flush mode type to be used for the query execution.
177: * The flush mode type applies to the query regardless of the
178: * flush mode type in use for the entity manager.
179: * @param flushMode
180: */
181: public Query setFlushMode(FlushModeType flushMode);
182: }
|