1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * This library is free software; you can redistribute it and/or modify it under
5    * the terms of the GNU Lesser General Public License as published by the Free
6    * Software Foundation; either version 2.1 of the License, or (at your option)
7    * any later version.
8    *
9    * This library is distributed in the hope that it will be useful, but WITHOUT
10   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11   * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
12   * details.
13   */
14  
15  package com.liferay.portal.kernel.dao.orm;
16  
17  import java.io.Serializable;
18  
19  import java.sql.Timestamp;
20  
21  import java.util.Iterator;
22  import java.util.List;
23  
24  /**
25   * <a href="Query.java.html"><b><i>View Source</i></b></a>
26   *
27   * @author Brian Wing Shun Chan
28   */
29  public interface Query {
30  
31      public int executeUpdate() throws ORMException;
32  
33      @SuppressWarnings("unchecked")
34      public Iterator iterate() throws ORMException;
35  
36      @SuppressWarnings("unchecked")
37      public Iterator iterate(boolean modifiable) throws ORMException;
38  
39      @SuppressWarnings("unchecked")
40      public List list() throws ORMException;
41  
42      @SuppressWarnings("unchecked")
43      public List list(boolean unmodifiable) throws ORMException;
44  
45      public ScrollableResults scroll() throws ORMException;
46  
47      public Query setBoolean(int pos, boolean value);
48  
49      public Query setCacheable(boolean cacheable);
50  
51      public Query setCacheMode(CacheMode cacheMode);
52  
53      public Query setCacheRegion(String cacheRegion);
54  
55      public Query setDouble(int pos, double value);
56  
57      public Query setFirstResult(int firstResult);
58  
59      public Query setFloat(int pos, float value);
60  
61      public Query setInteger(int pos, int value);
62  
63      public Query setLong(int pos, long value);
64  
65      public Query setMaxResults(int maxResults);
66  
67      public Query setShort(int pos, short value);
68  
69      public Query setSerializable(int pos, Serializable value);
70  
71      public Query setString(int pos, String value);
72  
73      public Query setTimestamp(int pos, Timestamp value);
74  
75      public Object uniqueResult() throws ORMException;
76  
77  }