org.firebirdsql.jdbc.FirebirdPreparedStatement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaybird Show documentation
JDBC Driver for the Firebird RDBMS
The newest version!
/*
 * Public Firebird Java API.
 *
 * 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.PreparedStatement;
import java.sql.SQLException;

import org.firebirdsql.gds.ISCConstants;

/**
 * Firebird extensions to the {@link PreparedStatement} interface.
 * 
 * @author Roman Rokytskyy
 */
@SuppressWarnings("unused")
public interface FirebirdPreparedStatement extends FirebirdStatement, PreparedStatement {
 
    /** A {@code SELECT} or multi-row DML with {@code RETURNING} statement. */
    int TYPE_SELECT = ISCConstants.isc_info_sql_stmt_select;

    /** An {@code INSERT} statement. */
    int TYPE_INSERT = ISCConstants.isc_info_sql_stmt_insert;

    /** An {@code UPDATE} statement. */
    int TYPE_UPDATE = ISCConstants.isc_info_sql_stmt_update;

    /** A {@code DELETE} statement. */
    int TYPE_DELETE = ISCConstants.isc_info_sql_stmt_delete;

    /** A DDL statement. */
    int TYPE_DDL = ISCConstants.isc_info_sql_stmt_ddl;

    /** A GET SEGMENT statement. */
    int TYPE_GET_SEGMENT = ISCConstants.isc_info_sql_stmt_get_segment;

    /** A PUT SEGMENT statement. */
    int TYPE_PUT_SEGMENT = ISCConstants.isc_info_sql_stmt_put_segment;

    /** An {@code EXECUTE PROCEDURE} or singleton DML with {@code RETURNING} statement. */
    int TYPE_EXEC_PROCEDURE = ISCConstants.isc_info_sql_stmt_exec_procedure;

    /** A {@code SET TRANSACTION} statement. */
    int TYPE_START_TRANS = ISCConstants.isc_info_sql_stmt_start_trans;

    /** A {@code COMMIT} statement. */
    int TYPE_COMMIT = ISCConstants.isc_info_sql_stmt_commit;

    /** A {@code ROLLBACK} statement. */
    int TYPE_ROLLBACK = ISCConstants.isc_info_sql_stmt_rollback;

    /** A {@code SELECT FOR UPDATE} statement. */
    int TYPE_SELECT_FOR_UPDATE = ISCConstants.isc_info_sql_stmt_select_for_upd;

    /** A {@code SET GENERATOR} statement. */
    int TYPE_SET_GENERATOR = ISCConstants.isc_info_sql_stmt_set_generator;

    /**
     * A {@code SAVEPOINT} statement.
     *
     * @since 6
     */
    int TYPE_SAVEPOINT = ISCConstants.isc_info_sql_stmt_savepoint;

    /**
     * Get the statement type of this PreparedStatement.
     * 
     * The returned value is one of the {@code TYPE_*} constant values defined in this interface.
     * 
     *
     * @return The identifier for the given statement's type
     */
    int getStatementType() throws SQLException;
   
}