View Javadoc
1   /*
2    * Copyright (c) 2000, 2001, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package javax.sql;
27  
28  import java.sql.*;
29  
30  /**
31   * An object that implements the <code>RowSetWriter</code> interface,
32   * called a <i>writer</i>. A writer may be registered with a <code>RowSet</code>
33   * object that supports the reader/writer paradigm.
34   * <P>
35   * If a disconnected <code>RowSet</code> object modifies some of its data,
36   * and it has a writer associated with it, it may be implemented so that it
37   * calls on the writer's <code>writeData</code> method internally
38   * to write the updates back to the data source. In order to do this, the writer
39   * must first establish a connection with the rowset's data source.
40   * <P>
41   * If the data to be updated has already been changed in the data source, there
42   * is a conflict, in which case the writer will not write
43   * the changes to the data source.  The algorithm the writer uses for preventing
44   * or limiting conflicts depends entirely on its implementation.
45   *
46   * @since 1.4
47   */
48  
49  public interface RowSetWriter {
50  
51    /**
52     * Writes the changes in this <code>RowSetWriter</code> object's
53     * rowset back to the data source from which it got its data.
54     *
55     * @param caller the <code>RowSet</code> object (1) that has implemented the
56     *         <code>RowSetInternal</code> interface, (2) with which this writer is
57     *        registered, and (3) that called this method internally
58     * @return <code>true</code> if the modified data was written; <code>false</code>
59     *          if not, which will be the case if there is a conflict
60     * @exception SQLException if a database access error occurs
61     */
62    boolean writeData(RowSetInternal caller) throws SQLException;
63  
64  }