offapi/com/sun/star/sdb/XColumnUpdate.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 sdb {
  25
  26
  27 /** is used to update data which is collected in a row.
  28  */
  29 published interface XColumnUpdate: com::sun::star::uno::XInterface
  30 {
  31
  32     /** gives a nullable column a null value.
  33         @throws com::sun::star::sdbc::SQLException
  34             if a database access error occurs.
  35      */
  36     void updateNull() raises (com::sun::star::sdbc::SQLException);
  37
  38     /** updates a column with a boolean value.
  39         @param x
  40             the new column value
  41         @throws com::sun::star::sdbc::SQLException
  42             if a database access error occurs.
  43      */
  44     void updateBoolean([in]boolean x) raises (com::sun::star::sdbc::SQLException);
  45
  46     /** updates a column with a byte value.
  47         @param x
  48             the new column value
  49         @throws com::sun::star::sdbc::SQLException
  50             if a database access error occurs.
  51      */
  52     void updateByte([in]byte x) raises (com::sun::star::sdbc::SQLException);
  53
  54     /** updates a column with a short value.
  55         @param x
  56             the new column value
  57         @throws com::sun::star::sdbc::SQLException
  58             if a database access error occurs.
  59      */
  60     void updateShort([in]short x) raises (com::sun::star::sdbc::SQLException);
  61
  62     /** updates a column with a long value.
  63         @param x
  64             the new column value
  65         @throws com::sun::star::sdbc::SQLException
  66             if a database access error occurs.
  67      */
  68     void updateInt([in]long x) raises (com::sun::star::sdbc::SQLException);
  69
  70     /** updates a column with a hyper value.
  71         @param x
  72             the new column value
  73         @throws com::sun::star::sdbc::SQLException
  74             if a database access error occurs.
  75      */
  76     void updateLong([in]hyper x) raises (com::sun::star::sdbc::SQLException);
  77
  78     /** updates a column with a float value.
  79         @param x
  80             the new column value
  81         @throws com::sun::star::sdbc::SQLException
  82             if a database access error occurs.
  83      */
  84     void updateFloat([in]float x) raises (com::sun::star::sdbc::SQLException);
  85
  86     /** updates a column with a double value.
  87         @param x
  88             the new column value
  89         @throws com::sun::star::sdbc::SQLException
  90             if a database access error occurs.
  91      */
  92     void updateDouble([in]double x) raises (com::sun::star::sdbc::SQLException);
  93
  94     /** updates a column with a string value.
  95         @param x
  96             the new column value
  97         @throws com::sun::star::sdbc::SQLException
  98             if a database access error occurs.
  99      */
 100     void updateString([in]string x) raises (com::sun::star::sdbc::SQLException);
 101
 102     /** updates a column with a byte array value.
 103         @param x
 104             the new column value
 105         @throws com::sun::star::sdbc::SQLException
 106             if a database access error occurs.
 107      */
 108     void updateBytes([in]sequence<byte> x) raises (com::sun::star::sdbc::SQLException);
 109
 110     /** updates a column with a Date 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 updateDate([in]com::sun::star::util::Date x)
 117         raises (com::sun::star::sdbc::SQLException);
 118
 119     /** updates a column with a Time 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 updateTime([in]com::sun::star::util::Time x)
 126         raises (com::sun::star::sdbc::SQLException);
 127
 128     /** updates a column with a Timestamp 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 updateTimestamp([in]com::sun::star::util::DateTime x)
 135       raises (com::sun::star::sdbc::SQLException);
 136
 137     /** updates a column with a stream value.
 138         @param x
 139             the new column value
 140         @param length
 141             the length of the stream
 142         @throws com::sun::star::sdbc::SQLException
 143             if a database access error occurs.
 144      */
 145     void updateBinaryStream([in]com::sun::star::io::XInputStream x,
 146                              [in]long length) raises (com::sun::star::sdbc::SQLException);
 147
 148     /** updates a column with a stream value.
 149         @param x
 150             the new column value
 151         @param length
 152             the length of the stream
 153         @throws com::sun::star::sdbc::SQLException
 154             if a database access error occurs.
 155      */
 156     void updateCharacterStream([in]com::sun::star::io::XInputStream x,
 157                                  [in]long length) raises (com::sun::star::sdbc::SQLException);
 158
 159     /** updates a column with an Object value.
 160         @param x
 161             the new column value
 162         @throws com::sun::star::sdbc::SQLException
 163             if a database access error occurs.
 164      */
 165     void updateObject([in]any x)
 166       raises (com::sun::star::sdbc::SQLException);
 167
 168     /** updates a column with an Object value.
 169         @param x
 170             the new column value
 171         @param scale
 172             the scale
 173         @throws com::sun::star::sdbc::SQLException
 174             if a database access error occurs.
 175      */
 176     void updateNumericObject([in]any x, [in]long scale)
 177       raises (com::sun::star::sdbc::SQLException);
 178 };
 179
 180
 181 }; }; }; };
 182
 183 /*===========================================================================
 184 ===========================================================================*/
 185
 186 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */