offapi/com/sun/star/sdbc/XRow.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 container {
  25  published interface XNameAccess;
  26 };};};};
  27
  28  module com {  module sun {  module star {  module sdbc {
  29
  30  published interface XRef;
  31  published interface XArray;
  32  published interface XBlob;
  33  published interface XClob;
  34
  35
  36 /** is used to access data which is collected in a row.
  37     All methods raise a
  38     com::sun::star::sdbc::SQLException
  39     if a database access error occurs.
  40  */
  41 published interface XRow: com::sun::star::uno::XInterface
  42 {
  43
  44     /** reports whether the last column read had a value of SQL NULL.
  45         Note that you must first call getXXX on a column to try to read
  46         its value and then call wasNull() to see if the value read was
  47         SQL NULL.
  48
  49         @returns
  50             `TRUE` if last column read was SQL NULL and `FALSE` otherwise
  51         @throws SQLException
  52                 if a database access error occurs.
  53      */
  54     boolean wasNull() raises (SQLException);
  55
  56     /** gets the value of a column in the current row as a string.
  57         @param columnIndex
  58             the first column is 1, the second is 2,
  59         @returns
  60             the column value; if the value is SQL NULL, the result is null
  61         @throws SQLException
  62                 if a database access error occurs.
  63      */
  64     string getString([in]long columnIndex) raises (SQLException);
  65
  66     /** gets the value of a column in the current row as boolean.
  67         @param columnIndex
  68             the first column is 1, the second is 2,
  69         @returns
  70             the column value; if the value is SQL NULL, the result is null
  71         @throws SQLException
  72                 if a database access error occurs.
  73      */
  74     boolean getBoolean([in]long columnIndex) raises (SQLException);
  75
  76     /** get the value of a column in the current row as a byte.
  77         @param columnIndex
  78             the first column is 1, the second is 2,
  79         @returns
  80             the column value; if the value is SQL NULL, the result is null
  81         @throws SQLException
  82                 if a database access error occurs.
  83      */
  84     byte getByte([in]long columnIndex) raises (SQLException);
  85
  86     /** gets the value of a column in the current row as a short.
  87         @param columnIndex
  88             the first column is 1, the second is 2,
  89         @returns
  90             the column value; if the value is SQL NULL, the result is null
  91         @throws SQLException
  92                 if a database access error occurs.
  93      */
  94     short getShort([in]long columnIndex) raises (SQLException);
  95
  96     /** get the value of a column in the current row as an integer.
  97         @param columnIndex
  98             the first column is 1, the second is 2,
  99         @returns
 100             the column value; if the value is SQL NULL, the result is null
 101         @throws SQLException
 102                 if a database access error occurs.
 103      */
 104     long getInt([in]long columnIndex) raises (SQLException);
 105
 106     /** get the value of a column in the current row as a long.
 107         @param columnIndex
 108             the first column is 1, the second is 2,
 109         @returns
 110             the column value; if the value is SQL NULL, the result is null
 111         @throws SQLException
 112                 if a database access error occurs.
 113      */
 114     hyper getLong([in]long columnIndex) raises (SQLException);
 115
 116     /** gets the value of a column in the current row as a float.
 117         @param columnIndex
 118             the first column is 1, the second is 2,
 119         @returns
 120             the column value; if the value is SQL NULL, the result is null
 121         @throws SQLException
 122                 if a database access error occurs.
 123      */
 124     float getFloat([in]long columnIndex) raises (SQLException);
 125
 126     /** gets the value of a column in the current row as a double.
 127         @param columnIndex
 128             the first column is 1, the second is 2,
 129         @returns
 130             the column value; if the value is SQL NULL, the result is null
 131         @throws SQLException
 132                 if a database access error occurs.
 133      */
 134     double getDouble([in]long columnIndex) raises (SQLException);
 135
 136     /** gets the value of a column in the current row as a byte array.
 137              The bytes represent the raw values returned by the driver.
 138              @param columnIndex
 139                 the first column is 1, the second is 2, ...
 140              @returns
 141                 the column value; if the value is SQL NULL, the result is empty.
 142              @throws SQLException
 143                 if a database access error occurs.
 144      */
 145     sequence<byte> getBytes([in]long columnIndex) raises (SQLException);
 146
 147     /** gets the value of a column in the current row as a date object.
 148         @param columnIndex
 149             the first column is 1, the second is 2,
 150         @returns
 151             the column value; if the value is SQL NULL, the result is null
 152         @throws SQLException
 153                 if a database access error occurs.
 154      */
 155     com::sun::star::util::Date getDate([in]long columnIndex)
 156         raises (SQLException);
 157
 158     /** gets the value of a column in the current row as a time object.
 159         @param columnIndex
 160             the first column is 1, the second is 2,
 161         @returns
 162             the column value; if the value is SQL NULL, the result is null
 163         @throws SQLException
 164                 if a database access error occurs.
 165      */
 166     com::sun::star::util::Time getTime([in]long columnIndex)
 167         raises (SQLException);
 168
 169     /** gets the value of a column in the current row as a datetime object.
 170         @param columnIndex
 171             the first column is 1, the second is 2,
 172         @returns
 173             the column value; if the value is SQL NULL, the result is null
 174         @throws SQLException
 175                 if a database access error occurs.
 176      */
 177     com::sun::star::util::DateTime getTimestamp([in]long columnIndex)
 178         raises (SQLException);
 179
 180     /** gets the value of a column in the current row as a stream of
 181         uninterpreted bytes. The value can then be read in chunks from the
 182         stream. This method is particularly suitable for retrieving large
 183         LONGVARBINARY values.
 184
 185
 186         <p>
 187         <b>Note:</b> All the data in the returned stream must be
 188         read prior to getting the value of any other column. The next
 189         call to a get method implicitly closes the stream. Also, a
 190         stream may return 0 when the method
 191         com::sun::star::io::XInputStream::available()
 192         is called whether there is data
 193         available or not.
 194         </p>
 195         @param columnIndex
 196             the first column is 1, the second is 2,
 197         @returns
 198             the column value; if the value is SQL NULL, the result is null
 199         @throws SQLException
 200                 if a database access error occurs.
 201      */
 202     com::sun::star::io::XInputStream getBinaryStream([in]long columnIndex)
 203         raises (SQLException);
 204
 205     /** gets the value of a column in the current row as a stream of
 206         uninterpreted bytes. The value can then be read in chunks from the
 207         stream. This method is particularly suitable for retrieving large
 208         LONGVARBINARY or LONGVARCHAR values.
 209
 210
 211         <p>
 212         <b>Note:</b> All the data in the returned stream must be
 213         read prior to getting the value of any other column. The next
 214         call to a get method implicitly closes the stream. Also, a
 215         stream may return 0 when the method
 216         com::sun::star::io::XInputStream::available()
 217         is called whether there is data
 218         available or not.
 219         </p>
 220         @param columnIndex
 221             the first column is 1, the second is 2,
 222         @returns
 223             the column value; if the value is SQL NULL, the result is null
 224         @throws SQLException
 225                 if a database access error occurs.
 226      */
 227     com::sun::star::io::XInputStream getCharacterStream([in]long columnIndex)
 228         raises (SQLException);
 229
 230     /** returns the value of a column in the current row as an object.
 231         This method uses the given
 232         <code>Map</code>
 233         object for the custom mapping of the SQL structure or distinct type
 234         that is being retrieved.
 235         @param columnIndex
 236             the first column is 1, the second is 2,
 237         @param typeMap
 238             the map of types which should be used to get the column value
 239         @returns
 240             the column value; if the value is SQL NULL, the result is null
 241         @throws SQLException
 242                 if a database access error occurs.
 243      */
 244     any getObject([in]long columnIndex,
 245                   [in]com::sun::star::container::XNameAccess typeMap)
 246         raises (SQLException);
 247
 248     /** gets a REF(&amp;lt;structured-type&amp;gt;) column value from the current row.
 249         @param columnIndex
 250             the first column is 1, the second is 2,
 251         @returns
 252             the column value; if the value is SQL NULL, the result is null
 253         @throws SQLException
 254                 if a database access error occurs.
 255      */
 256     XRef getRef([in]long columnIndex) raises (SQLException);
 257
 258     /** gets a BLOB value in the current row.
 259         @param columnIndex
 260             the first column is 1, the second is 2,
 261         @returns
 262             the column value; if the value is SQL NULL, the result is null
 263         @throws SQLException
 264                 if a database access error occurs.
 265      */
 266     XBlob getBlob([in]long columnIndex) raises (SQLException);
 267
 268     /** gets a CLOB value in the current row of this
 269         <code>ResultSet</code>
 270         object.
 271         @param columnIndex
 272             the first column is 1, the second is 2,
 273         @returns
 274             the column value; if the value is SQL NULL, the result is null
 275         @throws SQLException
 276             if a database access error occurs.
 277      */
 278     XClob getClob([in]long columnIndex) raises (SQLException);
 279
 280     /** gets a SQL ARRAY value from the current row of this
 281         <code>ResultSet</code>
 282         object.
 283         @param columnIndex
 284             the first column is 1, the second is 2,
 285         @returns
 286             the column value; if the value is SQL NULL, the result is null
 287         @throws SQLException
 288                 if a database access error occurs.
 289      */
 290     XArray getArray([in]long columnIndex) raises (SQLException);
 291 };
 292
 293
 294 }; }; }; };
 295
 296 /*===========================================================================
 297 ===========================================================================*/
 298
 299 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */