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

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