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
  20  module com {  module sun {  module star {  module io {
  21  published interface XInputStream;
  22 };};};};
  23
  24  module com {  module sun {  module star {  module sdbc {
  25
  26
  27 /** is used to update data which is collected in a row.
  28  */
  29 published interface XRowUpdate: com::sun::star::uno::XInterface
  30 {
  31
  32     /** gives a nullable column a null value.
  33         @param columnIndex
  34             the position of the column
  35         @throws SQLException
  36             if a database access error occurs.
  37      */
  38     void updateNull([in]long columnIndex) raises (SQLException);
  39
  40     /** updates a column with a boolean value.
  41         @param columnIndex
  42             the position of the column
  43         @param x
  44             the new column value
  45         @throws SQLException
  46             if a database access error occurs.
  47      */
  48     void updateBoolean([in]long columnIndex, [in]boolean x) raises (SQLException);
  49
  50     /** updates a column with a byte value.
  51         @param columnIndex
  52             the position of the column
  53         @param x
  54             the new column value
  55         @throws SQLException
  56             if a database access error occurs.
  57      */
  58     void updateByte([in]long columnIndex, [in]byte x) raises (SQLException);
  59
  60     /** updates a column with a short value.
  61         @param columnIndex
  62             the position of the column
  63         @param x
  64             the new column value
  65         @throws SQLException
  66             if a database access error occurs.
  67      */
  68     void updateShort([in]long columnIndex, [in]short x) raises (SQLException);
  69
  70     /** updates a column with an long value.
  71         @param columnIndex
  72             the position of the column
  73         @param x
  74             the new column value
  75         @throws SQLException
  76             if a database access error occurs.
  77      */
  78     void updateInt([in]long columnIndex, [in]long x) raises (SQLException);
  79
  80     /** updates a column with a hyper value.
  81         @param columnIndex
  82             the position of the column
  83         @param x
  84             the new column value
  85         @throws SQLException
  86             if a database access error occurs.
  87      */
  88     void updateLong([in]long columnIndex, [in]hyper x) raises (SQLException);
  89
  90     /** updates a column with a float value.
  91         @param columnIndex
  92             the position of the column
  93         @param x
  94             the new column value
  95         @throws SQLException
  96             if a database access error occurs.
  97      */
  98     void updateFloat([in]long columnIndex, [in]float x) raises (SQLException);
  99
 100     /** updates a column with a double 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 updateDouble([in]long columnIndex, [in]double x) raises (SQLException);
 109
 110     /** updates a column with a string value.
 111         @param columnIndex
 112             the position of the column
 113         @param x
 114             the new column value
 115         @throws SQLException
 116             if a database access error occurs.
 117      */
 118     void updateString([in]long columnIndex, [in]string x) raises (SQLException);
 119
 120     /** updates a column with a byte array value.
 121         @param columnIndex
 122             the position of the column
 123         @param x
 124             the new column value
 125         @throws SQLException
 126             if a database access error occurs.
 127      */
 128     void updateBytes([in]long columnIndex, [in]sequence<byte> x) raises (SQLException);
 129
 130     /** updates a column with a date value.
 131         @param columnIndex
 132             the position of the column
 133         @param x
 134             the new column value
 135         @throws SQLException
 136             if a database access error occurs.
 137      */
 138     void updateDate([in]long columnIndex, [in]com::sun::star::util::Date x)
 139         raises (SQLException);
 140
 141     /** updates a column with a time value.
 142         @param columnIndex
 143             the position of the column
 144         @param x
 145             the new column value
 146         @throws SQLException
 147             if a database access error occurs.
 148      */
 149     void updateTime([in]long columnIndex, [in]com::sun::star::util::Time x)
 150         raises (SQLException);
 151
 152     /** updates a column with a timestamp value.
 153         @param columnIndex
 154             the position of the column
 155         @param x
 156             the new column value
 157         @throws SQLException
 158             if a database access error occurs.
 159      */
 160     void updateTimestamp([in]long columnIndex,
 161                          [in]com::sun::star::util::DateTime x)
 162       raises (SQLException);
 163
 164     /** updates a column with a stream value.
 165         @param columnIndex
 166             the position of the column
 167         @param x
 168             the new column value
 169         @param length
 170             how much data should be read out of the stream
 171         @throws SQLException
 172             if a database access error occurs.
 173      */
 174     void updateBinaryStream([in]long columnIndex,
 175                              [in]com::sun::star::io::XInputStream x,
 176                               [in]long length) raises (SQLException);
 177
 178     /** updates a column with a stream value.
 179         @param columnIndex
 180             the position of the column
 181         @param x
 182             the new column value
 183         @param length
 184             how much data should be read out of the stream
 185         @throws SQLException
 186             if a database access error occurs.
 187      */
 188     void updateCharacterStream([in]long columnIndex,
 189                                 [in]com::sun::star::io::XInputStream x,
 190                                  [in]long length) raises (SQLException);
 191
 192     /** updates a column with an object value.
 193         @param columnIndex
 194             the position of the column
 195         @param x
 196             the new column value
 197         @throws SQLException
 198             if a database access error occurs.
 199      */
 200     void updateObject([in]long columnIndex, [in]any x)
 201       raises (SQLException);
 202
 203     /** updates a column with an object value.
 204         @param columnIndex
 205             the position of the column
 206         @param x
 207             the new column value
 208         @param scale
 209             defines the scale which should be used to write the numeric value
 210         @throws SQLException
 211             if a database access error occurs.
 212      */
 213     void updateNumericObject([in]long columnIndex, [in]any x, [in]long scale)
 214       raises (SQLException);
 215 };
 216
 217
 218 }; }; }; };
 219
 220 /*===========================================================================
 221 ===========================================================================*/
 222
 223 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */