summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdbc/XRowUpdate.idl
blob: e61286e116059aca16277da3b319380d2712397a (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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_sdbc_XRowUpdate_idl__
#define __com_sun_star_sdbc_XRowUpdate_idl__

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

#ifndef __com_sun_star_util_Date_idl__
#include <com/sun/star/util/Date.idl>
#endif

#ifndef __com_sun_star_util_DateTime_idl__
#include <com/sun/star/util/DateTime.idl>
#endif

#ifndef __com_sun_star_util_Time_idl__
#include <com/sun/star/util/Time.idl>
#endif

 module com {  module sun {  module star {  module io {
 published interface XInputStream;
};};};};

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

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


/** is used to update data which is collected in a row.
 */
published interface XRowUpdate: com::sun::star::uno::XInterface
{

    /** gives a nullable column a null value.
        @param columnIndex
            the position of the column
        @throws SQLException
            if a database access error occurs.
     */
    void updateNull([in]long columnIndex) raises (SQLException);
    //-------------------------------------------------------------------------

    /** updates a column with a boolean value.
        @param columnIndex
            the position of the column
        @param x
            the new column value
        @throws SQLException
            if a database access error occurs.
     */
    void updateBoolean([in]long columnIndex, [in]boolean x) raises (SQLException);
    //-------------------------------------------------------------------------

    /** updates a column with a byte value.
        @param columnIndex
            the position of the column
        @param x
            the new column value
        @throws SQLException
            if a database access error occurs.
     */
    void updateByte([in]long columnIndex, [in]byte x) raises (SQLException);
    //-------------------------------------------------------------------------

    /** updates a column with a short value.
        @param columnIndex
            the position of the column
        @param x
            the new column value
        @throws SQLException
            if a database access error occurs.
     */
    void updateShort([in]long columnIndex, [in]short x) raises (SQLException);
    //-------------------------------------------------------------------------

    /** updates a column with an long value.
        @param columnIndex
            the position of the column
        @param x
            the new column value
        @throws SQLException
            if a database access error occurs.
     */
    void updateInt([in]long columnIndex, [in]long x) raises (SQLException);
    //-------------------------------------------------------------------------

    /** updates a column with a hyper value.
        @param columnIndex
            the position of the column
        @param x
            the new column value
        @throws SQLException
            if a database access error occurs.
     */
    void updateLong([in]long columnIndex, [in]hyper x) raises (SQLException);
    //-------------------------------------------------------------------------

    /** updates a column with a float value.
        @param columnIndex
            the position of the column
        @param x
            the new column value
        @throws SQLException
            if a database access error occurs.
     */
    void updateFloat([in]long columnIndex, [in]float x) raises (SQLException);
    //-------------------------------------------------------------------------

    /** updates a column with a double value.
        @param columnIndex
            the position of the column
        @param x
            the new column value
        @throws SQLException
            if a database access error occurs.
     */
    void updateDouble([in]long columnIndex, [in]double x) raises (SQLException);
    //-------------------------------------------------------------------------

    /** updates a column with a string value.
        @param columnIndex
            the position of the column
        @param x
            the new column value
        @throws SQLException
            if a database access error occurs.
     */
    void updateString([in]long columnIndex, [in]string x) raises (SQLException);
    //-------------------------------------------------------------------------

    /** updates a column with a byte array value.
        @param columnIndex
            the position of the column
        @param x
            the new column value
        @throws SQLException
            if a database access error occurs.
     */
    void updateBytes([in]long columnIndex, [in]sequence<byte> x) raises (SQLException);
    //-------------------------------------------------------------------------

    /** updates a column with a date value.
        @param columnIndex
            the position of the column
        @param x
            the new column value
        @throws SQLException
            if a database access error occurs.
     */
    void updateDate([in]long columnIndex, [in]com::sun::star::util::Date x)
        raises (SQLException);
    //-------------------------------------------------------------------------

    /** updates a column with a time value.
        @param columnIndex
            the position of the column
        @param x
            the new column value
        @throws SQLException
            if a database access error occurs.
     */
    void updateTime([in]long columnIndex, [in]com::sun::star::util::Time x)
        raises (SQLException);
    //-------------------------------------------------------------------------

    /** updates a column with a timestamp value.
        @param columnIndex
            the position of the column
        @param x
            the new column value
        @throws SQLException
            if a database access error occurs.
     */
    void updateTimestamp([in]long columnIndex,
                         [in]com::sun::star::util::DateTime x)
      raises (SQLException);
    //-------------------------------------------------------------------------

    /** updates a column with a stream value.
        @param columnIndex
            the position of the column
        @param x
            the new column value
        @param length
            how much data should be read out of the stream
        @throws SQLException
            if a database access error occurs.
     */
    void updateBinaryStream([in]long columnIndex,
                             [in]com::sun::star::io::XInputStream x,
                              [in]long length) raises (SQLException);
    //-------------------------------------------------------------------------

    /** updates a column with a stream value.
        @param columnIndex
            the position of the column
        @param x
            the new column value
        @param length
            how much data should be read out of the stream
        @throws SQLException
            if a database access error occurs.
     */
    void updateCharacterStream([in]long columnIndex,
                                [in]com::sun::star::io::XInputStream x,
                                 [in]long length) raises (SQLException);
    //-------------------------------------------------------------------------

    /** updates a column with an object value.
        @param columnIndex
            the position of the column
        @param x
            the new column value
        @throws SQLException
            if a database access error occurs.
     */
    void updateObject([in]long columnIndex, [in]any x)
      raises (SQLException);
    //-------------------------------------------------------------------------

    /** updates a column with an object value.
        @param columnIndex
            the position of the column
        @param x
            the new column value
        @param scale
            defines the scale which should be used to write the numeric value
        @throws SQLException
            if a database access error occurs.
     */
    void updateNumericObject([in]long columnIndex, [in]any x, [in]long scale)
      raises (SQLException);
};

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

}; }; }; };

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