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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20  module com {  module sun {  module star {  module sdbc {
  21
  22
  23 /** provides the possibility to write changes made on a result set back to
  24     database.
  25  */
  26 published interface XResultSetUpdate: com::sun::star::uno::XInterface
  27 {
  28
  29     /** inserts the contents of the insert row into the result set and
  30         the database. Must be on the insert row when this method is called.
  31         @throws SQLException
  32                 if a database access error occurs.
  33      */
  34     void insertRow() raises (SQLException);
  35
  36     /** updates the underlying database with the new contents of the
  37         current row. Cannot be called when on the insert row.
  38         @throws SQLException
  39                 if a database access error occurs.
  40      */
  41     void updateRow() raises (SQLException);
  42
  43     /** deletes the current row from the result set and the underlying
  44         database. Cannot be called when on the insert row.
  45         @throws SQLException
  46                 if a database access error occurs.
  47      */
  48     void deleteRow() raises (SQLException);
  49
  50     /** cancels the updates made to a row.
  51
  52
  53         <p>
  54         This method may be called after calling an
  55         <code>updateXXX</code>
  56         method(s) and before calling
  57         com::sun::star::sdbc::XResultSetUpdate::updateRow()
  58         to rollback the updates made to a row. If no updates have been made or
  59         <code>updateRow</code>
  60         has already been called, then this method has no
  61         effect.
  62         </p>
  63         @throws SQLException
  64                 if a database access error occurs.
  65      */
  66     void cancelRowUpdates() raises (SQLException);
  67
  68     /** moves the cursor to the insert row.  The current cursor position is
  69         remembered while the cursor is positioned on the insert row.
  70
  71
  72         <p>
  73         The insert row is a special row associated with an updatable
  74         result set. It is essentially a buffer where a new row may
  75         be constructed by calling the
  76         <code>updateXXX</code>
  77         methods prior to
  78         inserting the row into the result set.
  79         </p>
  80         <p>
  81         Only the
  82         <code>updateXXX</code>
  83         ,
  84         <code>getXXX</code>
  85         ,
  86         and
  87         com::sun::star::sdbc::XResultSetUpdate::insertRow()
  88         methods may be
  89         called when the cursor is on the insert row.  All of the columns in
  90         a result set must be given a value each time this method is
  91         called before calling
  92         <code>insertRow</code>
  93         . The method
  94         <code>updateXXX</code>
  95         must be called before a
  96         <code>getXXX</code>
  97         method can be called on a column value.
  98         </p>
  99         @throws SQLException
 100                 if a database access error occurs.
 101      */
 102     void moveToInsertRow() raises (SQLException);
 103
 104     /** moves the cursor to the remembered cursor position, usually the
 105         current row. This method has no effect if the cursor is not on the insert
 106         row.
 107         @throws SQLException
 108                 if a database access error occurs.
 109      */
 110     void moveToCurrentRow() raises (SQLException);
 111 };
 112
 113
 114 }; }; }; };
 115
 116 /*===========================================================================
 117 ===========================================================================*/
 118
 119 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */