xref: /trunk/main/offapi/com/sun/star/sdbc/XRowUpdate.idl (revision cdf0e10c) 
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_sdbc_XRowUpdate_idl__
28#define __com_sun_star_sdbc_XRowUpdate_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_util_Date_idl__
35#include <com/sun/star/util/Date.idl>
36#endif
37
38#ifndef __com_sun_star_util_DateTime_idl__
39#include <com/sun/star/util/DateTime.idl>
40#endif
41
42#ifndef __com_sun_star_util_Time_idl__
43#include <com/sun/star/util/Time.idl>
44#endif
45
46 module com {  module sun {  module star {  module io {
47 published interface XInputStream;
48};};};};
49
50#ifndef __com_sun_star_sdbc_SQLException_idl__
51#include <com/sun/star/sdbc/SQLException.idl>
52#endif
53
54 module com {  module sun {  module star {  module sdbc {
55
56
57/** is used to update data which is collected in a row.
58 */
59published interface XRowUpdate: com::sun::star::uno::XInterface
60{
61
62	/** gives a nullable column a null value.
63		@param columnIndex
64			the position of the column
65		@throws SQLException
66			if a database access error occurs.
67	 */
68	void updateNull([in]long columnIndex) raises (SQLException);
69	//-------------------------------------------------------------------------
70
71	/** updates a column with a boolean value.
72		@param columnIndex
73			the position of the column
74		@param x
75			the new column value
76		@throws SQLException
77			if a database access error occurs.
78	 */
79	void updateBoolean([in]long columnIndex, [in]boolean x) raises (SQLException);
80	//-------------------------------------------------------------------------
81
82	/** updates a column with a byte value.
83		@param columnIndex
84			the position of the column
85		@param x
86			the new column value
87		@throws SQLException
88			if a database access error occurs.
89	 */
90	void updateByte([in]long columnIndex, [in]byte x) raises (SQLException);
91	//-------------------------------------------------------------------------
92
93	/** updates a column with a short value.
94		@param columnIndex
95			the position of the column
96		@param x
97			the new column value
98		@throws SQLException
99			if a database access error occurs.
100	 */
101	void updateShort([in]long columnIndex, [in]short x) raises (SQLException);
102	//-------------------------------------------------------------------------
103
104	/** updates a column with an long value.
105		@param columnIndex
106			the position of the column
107		@param x
108			the new column value
109		@throws SQLException
110			if a database access error occurs.
111	 */
112	void updateInt([in]long columnIndex, [in]long x) raises (SQLException);
113	//-------------------------------------------------------------------------
114
115	/** updates a column with a hyper value.
116		@param columnIndex
117			the position of the column
118		@param x
119			the new column value
120		@throws SQLException
121			if a database access error occurs.
122	 */
123	void updateLong([in]long columnIndex, [in]hyper x) raises (SQLException);
124    //-------------------------------------------------------------------------
125
126	/** updates a column with a float value.
127		@param columnIndex
128			the position of the column
129		@param x
130			the new column value
131		@throws SQLException
132			if a database access error occurs.
133	 */
134	void updateFloat([in]long columnIndex, [in]float x) raises (SQLException);
135    //-------------------------------------------------------------------------
136
137	/** updates a column with a double value.
138		@param columnIndex
139			the position of the column
140		@param x
141			the new column value
142		@throws SQLException
143			if a database access error occurs.
144	 */
145	void updateDouble([in]long columnIndex, [in]double x) raises (SQLException);
146	//-------------------------------------------------------------------------
147
148	/** updates a column with a string value.
149		@param columnIndex
150			the position of the column
151		@param x
152			the new column value
153		@throws SQLException
154			if a database access error occurs.
155	 */
156	void updateString([in]long columnIndex, [in]string x) raises (SQLException);
157	//-------------------------------------------------------------------------
158
159	/** updates a column with a byte array value.
160		@param columnIndex
161			the position of the column
162		@param x
163			the new column value
164		@throws SQLException
165			if a database access error occurs.
166	 */
167	void updateBytes([in]long columnIndex, [in]sequence<byte> x) raises (SQLException);
168	//-------------------------------------------------------------------------
169
170	/** updates a column with a date value.
171		@param columnIndex
172			the position of the column
173		@param x
174			the new column value
175		@throws SQLException
176			if a database access error occurs.
177	 */
178	void updateDate([in]long columnIndex, [in]com::sun::star::util::Date x)
179		raises (SQLException);
180	//-------------------------------------------------------------------------
181
182	/** updates a column with a time value.
183		@param columnIndex
184			the position of the column
185		@param x
186			the new column value
187		@throws SQLException
188			if a database access error occurs.
189	 */
190	void updateTime([in]long columnIndex, [in]com::sun::star::util::Time x)
191		raises (SQLException);
192	//-------------------------------------------------------------------------
193
194	/** updates a column with a timestamp value.
195		@param columnIndex
196			the position of the column
197		@param x
198			the new column value
199		@throws SQLException
200			if a database access error occurs.
201	 */
202	void updateTimestamp([in]long columnIndex,
203						 [in]com::sun::star::util::DateTime x)
204      raises (SQLException);
205	//-------------------------------------------------------------------------
206
207	/** updates a column with a stream value.
208		@param columnIndex
209			the position of the column
210		@param x
211			the new column value
212		@param length
213			how much data should be read out of the stream
214		@throws SQLException
215			if a database access error occurs.
216	 */
217	void updateBinaryStream([in]long columnIndex,
218					 		[in]com::sun::star::io::XInputStream x,
219					  		[in]long length) raises (SQLException);
220	//-------------------------------------------------------------------------
221
222	/** updates a column with a stream value.
223		@param columnIndex
224			the position of the column
225		@param x
226			the new column value
227		@param length
228			how much data should be read out of the stream
229		@throws SQLException
230			if a database access error occurs.
231	 */
232	void updateCharacterStream([in]long columnIndex,
233					 		   [in]com::sun::star::io::XInputStream x,
234					  		   [in]long length) raises (SQLException);
235	//-------------------------------------------------------------------------
236
237	/** updates a column with an object value.
238		@param columnIndex
239			the position of the column
240		@param x
241			the new column value
242		@throws SQLException
243			if a database access error occurs.
244	 */
245	void updateObject([in]long columnIndex, [in]any x)
246      raises (SQLException);
247	//-------------------------------------------------------------------------
248
249	/** updates a column with an object value.
250		@param columnIndex
251			the position of the column
252		@param x
253			the new column value
254		@param scale
255			defines the scale which should be used to write the numeric value
256		@throws SQLException
257			if a database access error occurs.
258	 */
259	void updateNumericObject([in]long columnIndex, [in]any x, [in]long scale)
260      raises (SQLException);
261};
262
263//=============================================================================
264
265}; }; }; };
266
267/*===========================================================================
268===========================================================================*/
269#endif
270