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