summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdbc/XResultSetUpdate.idl
blob: 50bfd144d3d9407869a44d933cf073e3e639f434 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
/*************************************************************************
 *
 *  $RCSfile: XResultSetUpdate.idl,v $
 *
 *  $Revision: 1.1 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_sdbc_XResultSetUpdate_idl__
#define __com_sun_star_sdbc_XResultSetUpdate_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_sdbc_SQLException_idl__
#include <com/sun/star/sdbc/SQLException.idl>
#endif

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


// DocMerge from xml: interface com::sun::star::sdbc::XResultSetUpdate
/** provides the possiblity to write changes mode on a result set back to
    database.
 */
[ uik(D6B6024A-9067-11d3-9EE00010-5AD7A5C4), ident("XResultSetUpdate", 1.0) ]
interface XResultSetUpdate: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::insertRow
    /** 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.
     */
    void insertRow() raises (SQLException);
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::updateRow
    /** updates the underlying database with the new contents of the
        current row. Cannot be called when on the insert row.
     */
    void updateRow() raises (SQLException);
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::deleteRow
    /** deletes the current row from the result set and the underlying
        database. Cannot be called when on the insert row.
     */
    void deleteRow() raises (SQLException);
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::cancelRowUpdates
    /** cancels the updates made to a row.


        <p>This method may be called after calling an
        <code>updateXXX</code> method(s) and before calling <code>updateRow</code>
        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>
     */
    void cancelRowUpdates() raises (SQLException);
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::moveToInsertRow
    /** 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 <code>insertRow</code> 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>
     */
    void moveToInsertRow() raises (SQLException);
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::moveToCurrentRow
    /** 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.
     */
    void moveToCurrentRow() raises (SQLException);
};

//=============================================================================

}; }; }; };

/*===========================================================================
    $Log: not supported by cvs2svn $
    Revision 1.1.1.1  2000/09/18 23:35:43  hjs
    initial import

    Revision 1.5  2000/09/11 11:52:43  mi
    documentation merged from XML

    Revision 1.3  2000/01/27 08:35:29  dg
    #72102# documentation of insertRow()

    Revision 1.2  2000/01/06 07:27:42  dg
    #70278# rowDeleted moved to XResultSet

    Revision 1.1  1999/11/24 08:41:08  dg
    new StarDataBaseConnectivity

===========================================================================*/
#endif