1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.kernel.dao.orm;
24  
25  import java.io.Serializable;
26  
27  import java.sql.Timestamp;
28  
29  import java.util.Iterator;
30  import java.util.List;
31  
32  /**
33   * <a href="Query.java.html"><b><i>View Source</i></b></a>
34   *
35   * @author Brian Wing Shun Chan
36   */
37  public interface Query {
38  
39      public int executeUpdate() throws ORMException;
40  
41      public Iterator iterate() throws ORMException;
42  
43      public Iterator iterate(boolean modifiable) throws ORMException;
44  
45      public List list() throws ORMException;
46  
47      public List list(boolean unmodifiable) throws ORMException;
48  
49      public ScrollableResults scroll() throws ORMException;
50  
51      public Query setBoolean(int pos, boolean value);
52  
53      public Query setCacheable(boolean cacheable);
54  
55      public Query setCacheMode(CacheMode cacheMode);
56  
57      public Query setCacheRegion(String cacheRegion);
58  
59      public Query setDouble(int pos, double value);
60  
61      public Query setFirstResult(int firstResult);
62  
63      public Query setFloat(int pos, float value);
64  
65      public Query setInteger(int pos, int value);
66  
67      public Query setLong(int pos, long value);
68  
69      public Query setMaxResults(int maxResults);
70  
71      public Query setShort(int pos, short value);
72  
73      public Query setSerializable(int pos, Serializable value);
74  
75      public Query setString(int pos, String value);
76  
77      public Query setTimestamp(int pos, Timestamp value);
78  
79      public Object uniqueResult() throws ORMException;
80  
81  }