com.mckoi.database.jdbc.QueryResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mckoisqldb Show documentation

A full SQL database system with JDBC driver that can be embedded in a Java application or operate as a stand-alone server with clients connecting via TCP/IP.

The newest version!

/**
 * com.mckoi.database.jdbc.QueryResponse  16 Aug 2000
 *
 * Mckoi SQL Database ( http://www.mckoi.com/database )
 * Copyright (C) 2000, 2001, 2002  Diehl and Associates, Inc.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * Version 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License Version 2 for more details.
 *
 * You should have received a copy of the GNU General Public License
 * Version 2 along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * Change Log:
 * 
 * 
 */

package com.mckoi.database.jdbc;

import com.mckoi.database.global.ColumnDescription;

/**
 * The response to a query executed via the 'execQuery' method in the
 * DatabaseInterface interface.  This contains general information about the
 * result of the query.
 *
 * @author Tobias Downer
 */

public interface QueryResponse {

  /**
   * Returns a number that identifies this query within the set of queries
   * executed on the connection.  This is used for identifying this query
   * in subsequent operations.
   */
  int getResultID();

  /**
   * The time, in milliseconds, that the query took to execute.
   */
  int getQueryTimeMillis();

  /**
   * The total number of rows in the query result.  This is known ahead of
   * time, even if no data in the query has been accessed.
   */
  int getRowCount();

  /**
   * The number of columns in the query result.
   */
  int getColumnCount();

  /**
   * The ColumnDescription object that describes column 'n' in the result.  0
   * is the first column, 1 is the second column, etc.
   */
  ColumnDescription getColumnDescription(int column);

  /**
   * Returns any warnings about the query.  If there were no warnings then
   * this can return 'null'.
   */
  String getWarnings();

}