offapi/com/sun/star/sdbc/XRowUpdate.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_sdbc_XRowUpdate_idl__
  20 #define __com_sun_star_sdbc_XRowUpdate_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/util/Date.idl>
  25
  26 #include <com/sun/star/util/DateTime.idl>
  27
  28 #include <com/sun/star/util/Time.idl>
  29
  30  module com {  module sun {  module star {  module io {
  31  published interface XInputStream;
  32 };};};};
  33
  34 #include <com/sun/star/sdbc/SQLException.idl>
  35
  36  module com {  module sun {  module star {  module sdbc {
  37
  38
  39 /** is used to update data which is collected in a row.
  40  */
  41 published interface XRowUpdate: com::sun::star::uno::XInterface
  42 {
  43
  44     /** gives a nullable column a null value.
  45         @param columnIndex
  46             the position of the column
  47         @throws SQLException
  48             if a database access error occurs.
  49      */
  50     void updateNull([in]long columnIndex) raises (SQLException);
  51
  52     /** updates a column with a boolean value.
  53         @param columnIndex
  54             the position of the column
  55         @param x
  56             the new column value
  57         @throws SQLException
  58             if a database access error occurs.
  59      */
  60     void updateBoolean([in]long columnIndex, [in]boolean x) raises (SQLException);
  61
  62     /** updates a column with a byte value.
  63         @param columnIndex
  64             the position of the column
  65         @param x
  66             the new column value
  67         @throws SQLException
  68             if a database access error occurs.
  69      */
  70     void updateByte([in]long columnIndex, [in]byte x) raises (SQLException);
  71
  72     /** updates a column with a short value.
  73         @param columnIndex
  74             the position of the column
  75         @param x
  76             the new column value
  77         @throws SQLException
  78             if a database access error occurs.
  79      */
  80     void updateShort([in]long columnIndex, [in]short x) raises (SQLException);
  81
  82     /** updates a column with an long 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 updateInt([in]long columnIndex, [in]long x) raises (SQLException);
  91
  92     /** updates a column with a hyper value.
  93         @param columnIndex
  94             the position of the column
  95         @param x
  96             the new column value
  97         @throws SQLException
  98             if a database access error occurs.
  99      */
 100     void updateLong([in]long columnIndex, [in]hyper x) raises (SQLException);
 101
 102     /** updates a column with a float value.
 103         @param columnIndex
 104             the position of the column
 105         @param x
 106             the new column value
 107         @throws SQLException
 108             if a database access error occurs.
 109      */
 110     void updateFloat([in]long columnIndex, [in]float x) raises (SQLException);
 111
 112     /** updates a column with a double value.
 113         @param columnIndex
 114             the position of the column
 115         @param x
 116             the new column value
 117         @throws SQLException
 118             if a database access error occurs.
 119      */
 120     void updateDouble([in]long columnIndex, [in]double x) raises (SQLException);
 121
 122     /** updates a column with a string 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 updateString([in]long columnIndex, [in]string x) raises (SQLException);
 131
 132     /** updates a column with a byte array value.
 133         @param columnIndex
 134             the position of the column
 135         @param x
 136             the new column value
 137         @throws SQLException
 138             if a database access error occurs.
 139      */
 140     void updateBytes([in]long columnIndex, [in]sequence<byte> x) raises (SQLException);
 141
 142     /** updates a column with a date value.
 143         @param columnIndex
 144             the position of the column
 145         @param x
 146             the new column value
 147         @throws SQLException
 148             if a database access error occurs.
 149      */
 150     void updateDate([in]long columnIndex, [in]com::sun::star::util::Date x)
 151         raises (SQLException);
 152
 153     /** updates a column with a time value.
 154         @param columnIndex
 155             the position of the column
 156         @param x
 157             the new column value
 158         @throws SQLException
 159             if a database access error occurs.
 160      */
 161     void updateTime([in]long columnIndex, [in]com::sun::star::util::Time x)
 162         raises (SQLException);
 163
 164     /** updates a column with a timestamp value.
 165         @param columnIndex
 166             the position of the column
 167         @param x
 168             the new column value
 169         @throws SQLException
 170             if a database access error occurs.
 171      */
 172     void updateTimestamp([in]long columnIndex,
 173                          [in]com::sun::star::util::DateTime x)
 174       raises (SQLException);
 175
 176     /** updates a column with a stream value.
 177         @param columnIndex
 178             the position of the column
 179         @param x
 180             the new column value
 181         @param length
 182             how much data should be read out of the stream
 183         @throws SQLException
 184             if a database access error occurs.
 185      */
 186     void updateBinaryStream([in]long columnIndex,
 187                              [in]com::sun::star::io::XInputStream x,
 188                               [in]long length) raises (SQLException);
 189
 190     /** updates a column with a stream value.
 191         @param columnIndex
 192             the position of the column
 193         @param x
 194             the new column value
 195         @param length
 196             how much data should be read out of the stream
 197         @throws SQLException
 198             if a database access error occurs.
 199      */
 200     void updateCharacterStream([in]long columnIndex,
 201                                 [in]com::sun::star::io::XInputStream x,
 202                                  [in]long length) raises (SQLException);
 203
 204     /** updates a column with an object value.
 205         @param columnIndex
 206             the position of the column
 207         @param x
 208             the new column value
 209         @throws SQLException
 210             if a database access error occurs.
 211      */
 212     void updateObject([in]long columnIndex, [in]any x)
 213       raises (SQLException);
 214
 215     /** updates a column with an object value.
 216         @param columnIndex
 217             the position of the column
 218         @param x
 219             the new column value
 220         @param scale
 221             defines the scale which should be used to write the numeric value
 222         @throws SQLException
 223             if a database access error occurs.
 224      */
 225     void updateNumericObject([in]long columnIndex, [in]any x, [in]long scale)
 226       raises (SQLException);
 227 };
 228
 229
 230 }; }; }; };
 231
 232 /*===========================================================================
 233 ===========================================================================*/
 234 #endif
 235
 236 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */