xref: /AOO41X/main/offapi/com/sun/star/sdbc/XRowUpdate.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdbc_XRowUpdate_idl__
24#define __com_sun_star_sdbc_XRowUpdate_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_util_Date_idl__
31#include <com/sun/star/util/Date.idl>
32#endif
33
34#ifndef __com_sun_star_util_DateTime_idl__
35#include <com/sun/star/util/DateTime.idl>
36#endif
37
38#ifndef __com_sun_star_util_Time_idl__
39#include <com/sun/star/util/Time.idl>
40#endif
41
42 module com {  module sun {  module star {  module io {
43 published interface XInputStream;
44};};};};
45
46#ifndef __com_sun_star_sdbc_SQLException_idl__
47#include <com/sun/star/sdbc/SQLException.idl>
48#endif
49
50 module com {  module sun {  module star {  module sdbc {
51
52
53/** is used to update data which is collected in a row.
54 */
55published interface XRowUpdate: com::sun::star::uno::XInterface
56{
57
58    /** gives a nullable column a null value.
59        @param columnIndex
60            the position of the column
61        @throws SQLException
62            if a database access error occurs.
63     */
64    void updateNull([in]long columnIndex) raises (SQLException);
65    //-------------------------------------------------------------------------
66
67    /** updates a column with a boolean value.
68        @param columnIndex
69            the position of the column
70        @param x
71            the new column value
72        @throws SQLException
73            if a database access error occurs.
74     */
75    void updateBoolean([in]long columnIndex, [in]boolean x) raises (SQLException);
76    //-------------------------------------------------------------------------
77
78    /** updates a column with a byte value.
79        @param columnIndex
80            the position of the column
81        @param x
82            the new column value
83        @throws SQLException
84            if a database access error occurs.
85     */
86    void updateByte([in]long columnIndex, [in]byte x) raises (SQLException);
87    //-------------------------------------------------------------------------
88
89    /** updates a column with a short value.
90        @param columnIndex
91            the position of the column
92        @param x
93            the new column value
94        @throws SQLException
95            if a database access error occurs.
96     */
97    void updateShort([in]long columnIndex, [in]short x) raises (SQLException);
98    //-------------------------------------------------------------------------
99
100    /** updates a column with an long value.
101        @param columnIndex
102            the position of the column
103        @param x
104            the new column value
105        @throws SQLException
106            if a database access error occurs.
107     */
108    void updateInt([in]long columnIndex, [in]long x) raises (SQLException);
109    //-------------------------------------------------------------------------
110
111    /** updates a column with a hyper value.
112        @param columnIndex
113            the position of the column
114        @param x
115            the new column value
116        @throws SQLException
117            if a database access error occurs.
118     */
119    void updateLong([in]long columnIndex, [in]hyper x) raises (SQLException);
120    //-------------------------------------------------------------------------
121
122    /** updates a column with a float value.
123        @param columnIndex
124            the position of the column
125        @param x
126            the new column value
127        @throws SQLException
128            if a database access error occurs.
129     */
130    void updateFloat([in]long columnIndex, [in]float x) raises (SQLException);
131    //-------------------------------------------------------------------------
132
133    /** updates a column with a double value.
134        @param columnIndex
135            the position of the column
136        @param x
137            the new column value
138        @throws SQLException
139            if a database access error occurs.
140     */
141    void updateDouble([in]long columnIndex, [in]double x) raises (SQLException);
142    //-------------------------------------------------------------------------
143
144    /** updates a column with a string value.
145        @param columnIndex
146            the position of the column
147        @param x
148            the new column value
149        @throws SQLException
150            if a database access error occurs.
151     */
152    void updateString([in]long columnIndex, [in]string x) raises (SQLException);
153    //-------------------------------------------------------------------------
154
155    /** updates a column with a byte array value.
156        @param columnIndex
157            the position of the column
158        @param x
159            the new column value
160        @throws SQLException
161            if a database access error occurs.
162     */
163    void updateBytes([in]long columnIndex, [in]sequence<byte> x) raises (SQLException);
164    //-------------------------------------------------------------------------
165
166    /** updates a column with a date value.
167        @param columnIndex
168            the position of the column
169        @param x
170            the new column value
171        @throws SQLException
172            if a database access error occurs.
173     */
174    void updateDate([in]long columnIndex, [in]com::sun::star::util::Date x)
175        raises (SQLException);
176    //-------------------------------------------------------------------------
177
178    /** updates a column with a time value.
179        @param columnIndex
180            the position of the column
181        @param x
182            the new column value
183        @throws SQLException
184            if a database access error occurs.
185     */
186    void updateTime([in]long columnIndex, [in]com::sun::star::util::Time x)
187        raises (SQLException);
188    //-------------------------------------------------------------------------
189
190    /** updates a column with a timestamp value.
191        @param columnIndex
192            the position of the column
193        @param x
194            the new column value
195        @throws SQLException
196            if a database access error occurs.
197     */
198    void updateTimestamp([in]long columnIndex,
199                         [in]com::sun::star::util::DateTime x)
200      raises (SQLException);
201    //-------------------------------------------------------------------------
202
203    /** updates a column with a stream value.
204        @param columnIndex
205            the position of the column
206        @param x
207            the new column value
208        @param length
209            how much data should be read out of the stream
210        @throws SQLException
211            if a database access error occurs.
212     */
213    void updateBinaryStream([in]long columnIndex,
214                            [in]com::sun::star::io::XInputStream x,
215                            [in]long length) raises (SQLException);
216    //-------------------------------------------------------------------------
217
218    /** updates a column with a stream value.
219        @param columnIndex
220            the position of the column
221        @param x
222            the new column value
223        @param length
224            how much data should be read out of the stream
225        @throws SQLException
226            if a database access error occurs.
227     */
228    void updateCharacterStream([in]long columnIndex,
229                               [in]com::sun::star::io::XInputStream x,
230                               [in]long length) raises (SQLException);
231    //-------------------------------------------------------------------------
232
233    /** updates a column with an object value.
234        @param columnIndex
235            the position of the column
236        @param x
237            the new column value
238        @throws SQLException
239            if a database access error occurs.
240     */
241    void updateObject([in]long columnIndex, [in]any x)
242      raises (SQLException);
243    //-------------------------------------------------------------------------
244
245    /** updates a column with an object value.
246        @param columnIndex
247            the position of the column
248        @param x
249            the new column value
250        @param scale
251            defines the scale which should be used to write the numeric value
252        @throws SQLException
253            if a database access error occurs.
254     */
255    void updateNumericObject([in]long columnIndex, [in]any x, [in]long scale)
256      raises (SQLException);
257};
258
259//=============================================================================
260
261}; }; }; };
262
263/*===========================================================================
264===========================================================================*/
265#endif
266