xref: /AOO41X/main/offapi/com/sun/star/sdb/XColumnUpdate.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_sdb_XColumnUpdate_idl__
24#define __com_sun_star_sdb_XColumnUpdate_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_sdbc_SQLException_idl__
31#include <com/sun/star/sdbc/SQLException.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 module com {  module sun {  module star {  module sdb {
51
52
53/** is used to update data which is collected in a row.
54 */
55published interface XColumnUpdate: com::sun::star::uno::XInterface
56{
57
58    /** gives a nullable column a null value.
59        @throws com::sun::star::sdbc::SQLException
60            if a database access error occurs.
61     */
62    void updateNull() raises (com::sun::star::sdbc::SQLException);
63    //-------------------------------------------------------------------------
64
65    /** updates a column with a boolean value.
66        @param x
67            the new column value
68        @throws com::sun::star::sdbc::SQLException
69            if a database access error occurs.
70     */
71    void updateBoolean([in]boolean x) raises (com::sun::star::sdbc::SQLException);
72    //-------------------------------------------------------------------------
73
74    /** updates a column with a byte value.
75        @param x
76            the new column value
77        @throws com::sun::star::sdbc::SQLException
78            if a database access error occurs.
79     */
80    void updateByte([in]byte x) raises (com::sun::star::sdbc::SQLException);
81    //-------------------------------------------------------------------------
82
83    /** updates a column with a short value.
84        @param x
85            the new column value
86        @throws com::sun::star::sdbc::SQLException
87            if a database access error occurs.
88     */
89    void updateShort([in]short x) raises (com::sun::star::sdbc::SQLException);
90    //-------------------------------------------------------------------------
91
92    /** updates a column with a long value.
93        @param x
94            the new column value
95        @throws com::sun::star::sdbc::SQLException
96            if a database access error occurs.
97     */
98    void updateInt([in]long x) raises (com::sun::star::sdbc::SQLException);
99    //-------------------------------------------------------------------------
100
101    /** updates a column with a hyper value.
102        @param x
103            the new column value
104        @throws com::sun::star::sdbc::SQLException
105            if a database access error occurs.
106     */
107    void updateLong([in]hyper x) raises (com::sun::star::sdbc::SQLException);
108    //-------------------------------------------------------------------------
109
110    /** updates a column with a float value.
111        @param x
112            the new column value
113        @throws com::sun::star::sdbc::SQLException
114            if a database access error occurs.
115     */
116    void updateFloat([in]float x) raises (com::sun::star::sdbc::SQLException);
117    //-------------------------------------------------------------------------
118
119    /** updates a column with a double value.
120        @param x
121            the new column value
122        @throws com::sun::star::sdbc::SQLException
123            if a database access error occurs.
124     */
125    void updateDouble([in]double x) raises (com::sun::star::sdbc::SQLException);
126    //-------------------------------------------------------------------------
127
128    /** updates a column with a string value.
129        @param x
130            the new column value
131        @throws com::sun::star::sdbc::SQLException
132            if a database access error occurs.
133     */
134    void updateString([in]string x) raises (com::sun::star::sdbc::SQLException);
135    //-------------------------------------------------------------------------
136
137    /** updates a column with a byte array value.
138        @param x
139            the new column value
140        @throws com::sun::star::sdbc::SQLException
141            if a database access error occurs.
142     */
143    void updateBytes([in]sequence<byte> x) raises (com::sun::star::sdbc::SQLException);
144    //-------------------------------------------------------------------------
145
146    /** updates a column with a Date value.
147        @param x
148            the new column value
149        @throws com::sun::star::sdbc::SQLException
150            if a database access error occurs.
151     */
152    void updateDate([in]com::sun::star::util::Date x)
153        raises (com::sun::star::sdbc::SQLException);
154    //-------------------------------------------------------------------------
155
156    /** updates a column with a Time value.
157        @param x
158            the new column value
159        @throws com::sun::star::sdbc::SQLException
160            if a database access error occurs.
161     */
162    void updateTime([in]com::sun::star::util::Time x)
163        raises (com::sun::star::sdbc::SQLException);
164    //-------------------------------------------------------------------------
165
166    /** updates a column with a Timestamp value.
167        @param x
168            the new column value
169        @throws com::sun::star::sdbc::SQLException
170            if a database access error occurs.
171     */
172    void updateTimestamp([in]com::sun::star::util::DateTime x)
173      raises (com::sun::star::sdbc::SQLException);
174    //-------------------------------------------------------------------------
175
176    /** updates a column with a stream value.
177        @param x
178            the new column value
179        @throws com::sun::star::sdbc::SQLException
180            if a database access error occurs.
181     */
182    void updateBinaryStream([in]com::sun::star::io::XInputStream x,
183                            [in]long length) raises (com::sun::star::sdbc::SQLException);
184    //-------------------------------------------------------------------------
185
186    /** updates a column with a stream value.
187        @param x
188            the new column value
189        @param length
190            the length of the stream
191        @throws com::sun::star::sdbc::SQLException
192            if a database access error occurs.
193     */
194    void updateCharacterStream([in]com::sun::star::io::XInputStream x,
195                               [in]long length) raises (com::sun::star::sdbc::SQLException);
196    //-------------------------------------------------------------------------
197
198    /** updates a column with an Object value.
199        @param x
200            the new column value
201        @throws com::sun::star::sdbc::SQLException
202            if a database access error occurs.
203     */
204    void updateObject([in]any x)
205      raises (com::sun::star::sdbc::SQLException);
206    //-------------------------------------------------------------------------
207
208    /** updates a column with an Object value.
209        @param x
210            the new column value
211        @param scale
212            the scale
213        @throws com::sun::star::sdbc::SQLException
214            if a database access error occurs.
215     */
216    void updateNumericObject([in]any x, [in]long scale)
217      raises (com::sun::star::sdbc::SQLException);
218};
219
220//=============================================================================
221
222}; }; }; };
223
224/*===========================================================================
225===========================================================================*/
226#endif
227