001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.dao.orm;
016    
017    import java.io.Serializable;
018    
019    import java.sql.Timestamp;
020    
021    import java.util.Iterator;
022    import java.util.List;
023    
024    /**
025     * @author Brian Wing Shun Chan
026     * @author Shuyang Zhou
027     */
028    public interface Query {
029    
030            public int executeUpdate() throws ORMException;
031    
032            @SuppressWarnings("rawtypes")
033            public Iterator iterate() throws ORMException;
034    
035            @SuppressWarnings("rawtypes")
036            public Iterator iterate(boolean modifiable) throws ORMException;
037    
038            @SuppressWarnings("rawtypes")
039            public List list() throws ORMException;
040    
041            @SuppressWarnings("rawtypes")
042            public List list(boolean unmodifiable) throws ORMException;
043    
044            @SuppressWarnings("rawtypes")
045            public List list(boolean copy, boolean unmodifiable) throws ORMException;
046    
047            public ScrollableResults scroll() throws ORMException;
048    
049            public Query setBoolean(int pos, boolean value);
050    
051            public Query setBoolean(String name, boolean value);
052    
053            public Query setCacheable(boolean cacheable);
054    
055            public Query setCacheMode(CacheMode cacheMode);
056    
057            public Query setCacheRegion(String cacheRegion);
058    
059            public Query setDouble(int pos, double value);
060    
061            public Query setDouble(String name, double value);
062    
063            public Query setFirstResult(int firstResult);
064    
065            public Query setFloat(int pos, float value);
066    
067            public Query setFloat(String name, float value);
068    
069            public Query setInteger(int pos, int value);
070    
071            public Query setInteger(String name, int value);
072    
073            public Query setLockMode(String alias, LockMode lockMode);
074    
075            public Query setLong(int pos, long value);
076    
077            public Query setLong(String name, long value);
078    
079            public Query setMaxResults(int maxResults);
080    
081            public Query setSerializable(int pos, Serializable value);
082    
083            public Query setSerializable(String name, Serializable value);
084    
085            public Query setShort(int pos, short value);
086    
087            public Query setShort(String name, short value);
088    
089            public Query setString(int pos, String value);
090    
091            public Query setString(String name, String value);
092    
093            public Query setTimestamp(int pos, Timestamp value);
094    
095            public Query setTimestamp(String name, Timestamp value);
096    
097            public Object uniqueResult() throws ORMException;
098    
099    }