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