001: /*
002: * $Id: AxionCommand.java,v 1.15 2005/12/22 09:02:30 ahimanikya Exp $
003: * =======================================================================
004: * Copyright (c) 2002-2006 Axion Development Team. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above
011: * copyright notice, this list of conditions and the following
012: * disclaimer.
013: *
014: * 2. Redistributions in binary form must reproduce the above copyright
015: * notice, this list of conditions and the following disclaimer in
016: * the documentation and/or other materials provided with the
017: * distribution.
018: *
019: * 3. The names "Tigris", "Axion", nor the names of its contributors may
020: * not be used to endorse or promote products derived from this
021: * software without specific prior written permission.
022: *
023: * 4. Products derived from this software may not be called "Axion", nor
024: * may "Tigris" or "Axion" appear in their names without specific prior
025: * written permission.
026: *
027: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
028: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
029: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
030: * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
031: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
032: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
033: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
034: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
035: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
036: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
037: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
038: * =======================================================================
039: */
040:
041: package org.axiondb;
042:
043: import java.sql.ResultSet;
044: import java.util.List;
045:
046: import org.axiondb.jdbc.AxionResultSet;
047:
048: /**
049: * A command to be executed against a {@link Database}.
050: *
051: * @version $Revision: 1.15 $ $Date: 2005/12/22 09:02:30 $
052: * @author Chuck Burdick
053: * @author Ahimanikya Satapathy
054: */
055: public interface AxionCommand {
056:
057: /**
058: * Sets the <i>values</i> of the all bind variable within this command.
059: *
060: * @param index the one-based index of the variable
061: * @param value the value to bind the variable to
062: */
063: void bindAll(Object[] values) throws AxionException;
064:
065: /**
066: * Clears all bind variables within this command.
067: */
068: void clearBindings() throws AxionException;
069:
070: /**
071: * Executes an SQL statement that may return multiple results.
072: *
073: * @return <tt>true</tt> if one or more {@link java.sql.ResultSet}s were generated,
074: * <tt>false</tt> otherwise
075: * @see java.sql.Statement#execute(java.lang.String)
076: * @see java.sql.PreparedStatement#execute
077: */
078: boolean execute(Database db) throws AxionException;
079:
080: /**
081: * Executes an SQL statement that returns a single read-only
082: * {@link java.sql.ResultSet} object such as a SELECT statement.
083: *
084: * @return the generated {@link java.sql.ResultSet}
085: * @see java.sql.Statement#executeQuery(java.lang.String)
086: * @see java.sql.PreparedStatement#executeQuery
087: */
088: AxionResultSet executeQuery(Database db) throws AxionException;
089:
090: /**
091: * Execute an SQL statement that returns a single {@link java.sql.ResultSet} object
092: * with the given read-only state.
093: *
094: * @param db Database in which query will be executed
095: * @param isReadOnly true if statement is read-only, false otherwise
096: * @return the generated {@link java.sql.ResultSet}
097: */
098: AxionResultSet executeQuery(Database db, boolean isReadOnly)
099: throws AxionException;
100:
101: /**
102: * Executes an SQL that may add, delete or modify zero or more rows within the
103: * database, such as an INSERT, UPDATE or DELETE statement. In addition, SQL
104: * statements that return nothing, such as SQL DDL statements, can be executed via
105: * this method.
106: *
107: * @return the number of rows modified
108: * @see java.sql.Statement#executeUpdate(java.lang.String)
109: * @see java.sql.PreparedStatement#executeUpdate
110: */
111: int executeUpdate(Database db) throws AxionException;
112:
113: List getBindVariables();
114:
115: /**
116: * Returns the last row count generated by {@link #execute} or {@link #executeUpdate}.
117: */
118: int getEffectedRowCount();
119:
120: /**
121: * Returns the last {@link java.sql.ResultSet} generated by {@link #execute} or
122: * {@link #executeQuery}.
123: */
124: ResultSet getResultSet();
125:
126: }
|