ISQLServerStatement.java

/*
 * Microsoft JDBC Driver for SQL Server
 * 
 * Copyright(c) Microsoft Corporation All rights reserved.
 * 
 * This program is made available under the terms of the MIT License. See the LICENSE file in the project root for more information.
 */

package com.microsoft.sqlserver.jdbc;

public interface ISQLServerStatement extends java.sql.Statement {
    /**
     * Sets the response buffering mode for this SQLServerStatement object to case-insensitive String full or adaptive.
     * <p>
     * Response buffering controls the driver's buffering of responses from SQL Server.
     * <p>
     * Possible values are:
     * <p>
     * "full" - Fully buffer the response at execution time.
     * <p>
     * "adaptive" - Data Pipe adaptive buffering
     * 
     * @param value
     *            A String that contains the response buffering mode. The valid mode can be one of the following case-insensitive Strings: full or
     *            adaptive.
     * @throws SQLServerException
     *             If there are any errors in setting the response buffering mode.
     */
    public void setResponseBuffering(String value) throws SQLServerException;

    /**
     * Retrieves the response buffering mode for this SQLServerStatement object.
     * 
     * @return A String that contains a lower-case full or adaptive.
     * @throws SQLServerException
     *             If there are any errors in retrieving the response buffering mode.
     */
    public String getResponseBuffering() throws SQLServerException;
}