org.firebirdsql.jdbc.FirebirdStatement Maven / Gradle / Ivy
Show all versions of jaybird-jdk15 Show documentation
/*
* Firebird Open Source J2ee connector - jdbc driver, public Firebird-specific
* JDBC extensions.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.firebirdsql.jdbc;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
/**
* Firebird-specific extensions to the {@link Statement} interface.
*
* @author Roman Rokytskyy
*/
public interface FirebirdStatement extends Statement {
/**
* The constant indicating that the current ResultSet object
* should be closed when calling getMoreResults.
*
* Copied from JDBC 3.0 definition
*/
int CLOSE_CURRENT_RESULT = 1;
/**
* The constant indicating that the current ResultSet object
* should not be closed when calling getMoreResults.
*
* Copied from JDBC 3.0 definition
*/
int KEEP_CURRENT_RESULT = 2;
/**
* The constant indicating that all ResultSet objects that
* have previously been kept open should be closed when calling
* getMoreResults.
*
* Copied from JDBC 3.0 definition
*/
int CLOSE_ALL_RESULTS = 3;
/**
* The constant indicating that generated keys should be made
* available for retrieval.
*
* @since 1.4
*/
int RETURN_GENERATED_KEYS = 1;
/**
* The constant indicating that generated keys should not be made
* available for retrieval.
*
* @since 1.4
*/
int NO_GENERATED_KEYS = 2;
/**
* Get number of inserted rows. You can call this method multiple times,
* it does not affect the JDBC result number.
*
* @return number of inserted rows or -1 if current result is result set.
*
* @throws SQLException if database error occurs.
*/
int getInsertedRowsCount() throws SQLException;
/**
* Get number of updated rows. You can call this method multiple times,
* it does not affect the JDBC result number.
*
* @return number of updated rows or -1 if current result is result set.
*
* @throws SQLException if database error occurs.
*/
int getUpdatedRowsCount() throws SQLException;
/**
* Get number of deleted rows. You can call this method multiple times,
* it does not affect the JDBC result number.
*
* @return number of deleted rows or -1 if current result is result set.
*
* @throws SQLException if database error occurs.
*/
int getDeletedRowsCount() throws SQLException;
/**
* Check if this statement has open result set. Note, this method works
* correctly if auto-commit is disabled. In auto-commit mode it will always
* return false because from the statement's point of view
* result set is not open (in auto-commit mode complete result set is fetched
* and cached in wrapping object before returning from the
* {@link #getResultSet()} method).
*
* @return true if there's already open result set associated
* with this statement, otherwise false.
*/
boolean hasOpenResultSet();
/**
* Get current result set. Behaviour of this method is similar to the
* behavior of the {@link Statement#getResultSet()}, except that this method
* can be called as much as you like.
*
* @return instance of {@link ResultSet} representing current result set
* or null if it is not available.
*
* @throws SQLException if database access error happened.
*/
ResultSet getCurrentResultSet() throws SQLException;
/**
* Check if this statement is valid.
*
* @return true if statement is valid and can be used to
* execute SQL.
*/
boolean isValid();
/**
* Get execution plan for the last executed statement. Unlike the
* {@link FirebirdPreparedStatement#getExecutionPlan()}, this method can be
* called only after executing a query or update statement.
*
* @return execution plan returned by the server.
*
* @throws SQLException if no statement was executed before calling this
* method, statement is not valid, or there was an error when obtaining
* the execution plan.
*/
String getLastExecutionPlan() throws SQLException;
/**
* Retrieves whether this Statement object has been closed. A Statement is closed if the
* method close has been called on it, or if it is automatically closed.
*
* Provided here for compatibility with Java 5
*
* @return true if this Statement object is closed; false if it is still open
* @throws SQLException if a database access error occurs
*/
boolean isClosed() throws SQLException;
}