offapi/com/sun/star/sdbc/XResultSetUpdate.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_sdbc_XResultSetUpdate_idl__
  29 #define __com_sun_star_sdbc_XResultSetUpdate_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32
  33 #include <com/sun/star/sdbc/SQLException.idl>
  34
  35  module com {  module sun {  module star {  module sdbc {
  36
  37
  38 /** provides the possibility to write changes made on a result set back to
  39     database.
  40  */
  41 published interface XResultSetUpdate: com::sun::star::uno::XInterface
  42 {
  43     //-------------------------------------------------------------------------
  44
  45     /** inserts the contents of the insert row into the result set and
  46         the database. Must be on the insert row when this method is called.
  47         @throws SQLException
  48                 if a database access error occurs.
  49      */
  50     void insertRow() raises (SQLException);
  51     //-------------------------------------------------------------------------
  52
  53     /** updates the underlying database with the new contents of the
  54         current row. Cannot be called when on the insert row.
  55         @throws SQLException
  56                 if a database access error occurs.
  57      */
  58     void updateRow() raises (SQLException);
  59     //-------------------------------------------------------------------------
  60
  61     /** deletes the current row from the result set and the underlying
  62         database. Cannot be called when on the insert row.
  63         @throws SQLException
  64                 if a database access error occurs.
  65      */
  66     void deleteRow() raises (SQLException);
  67     //-------------------------------------------------------------------------
  68
  69     /** cancels the updates made to a row.
  70
  71
  72         <p>
  73         This method may be called after calling an
  74         <code>updateXXX</code>
  75         method(s) and before calling
  76         <member scope="com::sun::star::sdbc">XResultSetUpdate::updateRow()</member>
  77         to rollback the updates made to a row. If no updates have been made or
  78         <code>updateRow</code>
  79         has already been called, then this method has no
  80         effect.
  81         </p>
  82         @throws SQLException
  83                 if a database access error occurs.
  84      */
  85     void cancelRowUpdates() raises (SQLException);
  86     //-------------------------------------------------------------------------
  87
  88     /** moves the cursor to the insert row.  The current cursor position is
  89         remembered while the cursor is positioned on the insert row.
  90
  91
  92         <p>
  93         The insert row is a special row associated with an updatable
  94         result set. It is essentially a buffer where a new row may
  95         be constructed by calling the
  96         <code>updateXXX</code>
  97         methods prior to
  98         inserting the row into the result set.
  99         </p>
 100         <p>
 101         Only the
 102         <code>updateXXX</code>
 103         ,
 104         <code>getXXX</code>
 105         ,
 106         and
 107         <member scope="com::sun::star::sdbc">XResultSetUpdate::insertRow()</member>
 108         methods may be
 109         called when the cursor is on the insert row.  All of the columns in
 110         a result set must be given a value each time this method is
 111         called before calling
 112         <code>insertRow</code>
 113         . The method
 114         <code>updateXXX</code>
 115         must be called before a
 116         <code>getXXX</code>
 117         method can be called on a column value.
 118         </p>
 119         @throws SQLException
 120                 if a database access error occurs.
 121      */
 122     void moveToInsertRow() raises (SQLException);
 123     //-------------------------------------------------------------------------
 124
 125     /** moves the cursor to the remembered cursor position, usually the
 126         current row. This method has no effect if the cursor is not on the insert
 127         row.
 128         @throws SQLException
 129                 if a database access error occurs.
 130      */
 131     void moveToCurrentRow() raises (SQLException);
 132 };
 133
 134 //=============================================================================
 135
 136 }; }; }; };
 137
 138 /*===========================================================================
 139 ===========================================================================*/
 140 #endif
 141
 142 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */