/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

 module com {  module sun {  module star {  module sdbc {


/** provides the possibility to write changes made on a result set back to
    database.
 */
published interface XResultSetUpdate: com::sun::star::uno::XInterface
{

    /** inserts the contents of the insert row into the result set and
        the database. Must be on the insert row when this method is called.
        @throws SQLException
                if a database access error occurs.
     */
    void insertRow() raises (SQLException);

    /** updates the underlying database with the new contents of the
        current row. Cannot be called when on the insert row.
        @throws SQLException
                if a database access error occurs.
     */
    void updateRow() raises (SQLException);

    /** deletes the current row from the result set and the underlying
        database. Cannot be called when on the insert row.
        @throws SQLException
                if a database access error occurs.
     */
    void deleteRow() raises (SQLException);

    /** cancels the updates made to a row.


        <p>
        This method may be called after calling an
        <code>updateXXX</code>
        method(s) and before calling
        com::sun::star::sdbc::XResultSetUpdate::updateRow()
        to rollback the updates made to a row. If no updates have been made or
        <code>updateRow</code>
        has already been called, then this method has no
        effect.
        </p>
        @throws SQLException
                if a database access error occurs.
     */
    void cancelRowUpdates() raises (SQLException);

    /** moves the cursor to the insert row.  The current cursor position is
        remembered while the cursor is positioned on the insert row.


        <p>
        The insert row is a special row associated with an updatable
        result set. It is essentially a buffer where a new row may
        be constructed by calling the
        <code>updateXXX</code>
        methods prior to
        inserting the row into the result set.
        </p>
        <p>
        Only the
        <code>updateXXX</code>
        ,
        <code>getXXX</code>
        ,
        and
        com::sun::star::sdbc::XResultSetUpdate::insertRow()
        methods may be
        called when the cursor is on the insert row.  All of the columns in
        a result set must be given a value each time this method is
        called before calling
        <code>insertRow</code>
        . The method
        <code>updateXXX</code>
        must be called before a
        <code>getXXX</code>
        method can be called on a column value.
        </p>
        @throws SQLException
                if a database access error occurs.
     */
    void moveToInsertRow() raises (SQLException);

    /** moves the cursor to the remembered cursor position, usually the
        current row. This method has no effect if the cursor is not on the insert
        row.
        @throws SQLException
                if a database access error occurs.
     */
    void moveToCurrentRow() raises (SQLException);
};


}; }; }; };

/*===========================================================================
===========================================================================*/

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
