001 /*
002 * Copyright 2000-2001 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.sql;
027
028 import java.sql.*;
029
030 /**
031 * The interface that a <code>RowSet</code> object implements in order to
032 * present itself to a <code>RowSetReader</code> or <code>RowSetWriter</code>
033 * object. The <code>RowSetInternal</code> interface contains
034 * methods that let the reader or writer access and modify the internal
035 * state of the rowset.
036 *
037 * @since 1.4
038 */
039
040 public interface RowSetInternal {
041
042 /**
043 * Retrieves the parameters that have been set for this
044 * <code>RowSet</code> object's command.
045 *
046 * @return an array of the current parameter values for this <code>RowSet</code>
047 * object's command
048 * @exception SQLException if a database access error occurs
049 */
050 Object[] getParams() throws SQLException;
051
052 /**
053 * Retrieves the <code>Connection</code> object that was passed to this
054 * <code>RowSet</code> object.
055 *
056 * @return the <code>Connection</code> object passed to the rowset
057 * or <code>null</code> if none was passed
058 * @exception SQLException if a database access error occurs
059 */
060 Connection getConnection() throws SQLException;
061
062 /**
063 * Sets the given <code>RowSetMetaData</code> object as the
064 * <code>RowSetMetaData</code> object for this <code>RowSet</code>
065 * object. The <code>RowSetReader</code> object associated with the rowset
066 * will use <code>RowSetMetaData</code> methods to set the values giving
067 * information about the rowset's columns.
068 *
069 * @param md the <code>RowSetMetaData</code> object that will be set with
070 * information about the rowset's columns
071 *
072 * @exception SQLException if a database access error occurs
073 */
074 void setMetaData(RowSetMetaData md) throws SQLException;
075
076 /**
077 * Retrieves a <code>ResultSet</code> object containing the original
078 * value of this <code>RowSet</code> object.
079 * <P>
080 * The cursor is positioned before the first row in the result set.
081 * Only rows contained in the result set returned by the method
082 * <code>getOriginal</code> are said to have an original value.
083 *
084 * @return the original value of the rowset
085 * @exception SQLException if a database access error occurs
086 */
087 public ResultSet getOriginal() throws SQLException;
088
089 /**
090 * Retrieves a <code>ResultSet</code> object containing the original value
091 * of the current row only. If the current row has no original value,
092 * an empty result set is returned. If there is no current row,
093 * an exception is thrown.
094 *
095 * @return the original value of the current row as a <code>ResultSet</code>
096 * object
097 * @exception SQLException if a database access error occurs or this method
098 * is called while the cursor is on the insert row, before the
099 * first row, or after the last row
100 */
101 public ResultSet getOriginalRow() throws SQLException;
102
103 }
|