offapi/com/sun/star/sdbc/XResultSetMetaData.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 #ifndef __com_sun_star_sdbc_XResultSetMetaData_idl__
  20 #define __com_sun_star_sdbc_XResultSetMetaData_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/sdbc/SQLException.idl>
  25
  26  module com {  module sun {  module star {  module sdbc {
  27
  28
  29 /** can be used to find out about the types and properties
  30     of the columns in a ResultSet.
  31  */
  32 published interface XResultSetMetaData: com::sun::star::uno::XInterface
  33 {
  34
  35     /** returns the number of columns in this ResultSet.
  36         @returns
  37             the column count
  38         @throws SQLException
  39             if a database access error occurs.
  40      */
  41     long getColumnCount() raises (SQLException);
  42
  43     /** indicates whether the column is automatically numbered, thus read-only.
  44         @param column
  45             the first column is 1, the second is 2,
  46         @returns
  47             `TRUE` if so
  48         @throws SQLException
  49             if a database access error occurs.
  50      */
  51     boolean isAutoIncrement([in]long column) raises (SQLException);
  52
  53     /** indicates whether a column's case matters.
  54         @param column
  55             the first column is 1, the second is 2,
  56         @returns
  57             `TRUE` if so
  58         @throws SQLException
  59             if a database access error occurs.
  60      */
  61     boolean isCaseSensitive([in]long column) raises (SQLException);
  62
  63     /** indicates whether the column can be used in a where clause.
  64         @param column
  65             the first column is 1, the second is 2,
  66         @returns
  67             `TRUE` if so
  68         @throws SQLException
  69             if a database access error occurs.
  70      */
  71     boolean isSearchable([in]long column) raises (SQLException);
  72
  73     /** indicates whether the column is a cash value.
  74         @param column
  75             the first column is 1, the second is 2,
  76         @returns
  77             `TRUE` if so
  78         @throws SQLException
  79             if a database access error occurs.
  80      */
  81     boolean isCurrency([in]long column) raises (SQLException);
  82
  83     /** indicates the nullability of values in the designated column.@see com::sun::star::sdbc::ColumnValue
  84         @param column
  85             the first column is 1, the second is 2,
  86         @returns
  87             `TRUE` if so
  88         @throws SQLException
  89             if a database access error occurs.
  90      */
  91     long isNullable([in]long column) raises (SQLException);
  92
  93     /** indicates whether values in the column are signed numbers.
  94         @param column
  95             the first column is 1, the second is 2,
  96         @returns
  97             `TRUE` if so
  98         @throws SQLException
  99             if a database access error occurs.
 100      */
 101     boolean isSigned([in]long column) raises (SQLException);
 102
 103     /** indicates the column's normal max width in chars.
 104         @param column
 105             the first column is 1, the second is 2,
 106         @returns
 107             the normal maximum number of characters allowed as the width of the designated column
 108         @throws SQLException
 109             if a database access error occurs.
 110      */
 111     long getColumnDisplaySize([in]long column) raises (SQLException);
 112
 113     /** gets the suggested column title for use in printouts and
 114         displays.
 115         @param column
 116             the first column is 1, the second is 2,
 117         @returns
 118             the suggested column title
 119         @throws SQLException
 120             if a database access error occurs.
 121      */
 122     string getColumnLabel([in]long column) raises (SQLException);
 123
 124     /** gets a column's name.
 125         @param column
 126             the first column is 1, the second is 2,
 127         @returns
 128             the column name
 129         @throws SQLException
 130             if a database access error occurs.
 131      */
 132     string getColumnName([in]long column) raises (SQLException);
 133
 134     /** gets a column's table's schema.
 135         @param column
 136             the first column is 1, the second is 2,
 137         @returns
 138             the schema name
 139         @throws SQLException
 140             if a database access error occurs.
 141      */
 142     string getSchemaName([in]long column) raises (SQLException);
 143
 144     /** gets a column's number of decimal digits.
 145         @param column
 146             the first column is 1, the second is 2,
 147         @returns
 148             precision
 149         @throws SQLException
 150             if a database access error occurs.
 151      */
 152     long getPrecision([in]long column) raises (SQLException);
 153
 154     /** gets a column's number of digits to right of the decimal point.
 155         @param column
 156             the first column is 1, the second is 2,
 157         @returns
 158             scale
 159         @throws SQLException
 160             if a database access error occurs.
 161      */
 162     long getScale([in]long column) raises (SQLException);
 163
 164     /** gets a column's table name.
 165         @param column
 166             the first column is 1, the second is 2,
 167         @returns
 168             the table name
 169         @throws SQLException
 170             if a database access error occurs.
 171      */
 172     string getTableName([in]long column) raises (SQLException);
 173
 174     /** gets a column's table's catalog name.
 175         @param column
 176             the first column is 1, the second is 2,
 177         @returns
 178             the catalog name
 179         @throws SQLException
 180             if a database access error occurs.
 181      */
 182     string getCatalogName([in]long column) raises (SQLException);
 183
 184     /** retrieves a column's SQL type.
 185         @param column
 186             the first column is 1, the second is 2,
 187         @returns
 188             the column type
 189         @throws SQLException
 190             if a database access error occurs.
 191      */
 192     long getColumnType([in]long column) raises (SQLException);
 193
 194     /** retrieves a column's database-specific type name.
 195         @param column
 196             the first column is 1, the second is 2,
 197         @returns
 198             the type name
 199         @throws SQLException
 200             if a database access error occurs.
 201      */
 202     string getColumnTypeName([in]long column) raises (SQLException);
 203
 204     /** indicates whether a column is definitely not writable.
 205         @param column
 206             the first column is 1, the second is 2,
 207         @returns
 208             `TRUE` if so
 209         @throws SQLException
 210             if a database access error occurs.
 211      */
 212     boolean isReadOnly([in]long column) raises (SQLException);
 213
 214     /** indicates whether it is possible for a write on the column to succeed.
 215         @param column
 216             the first column is 1, the second is 2,
 217         @returns
 218             `TRUE` if so
 219         @throws SQLException
 220             if a database access error occurs.
 221      */
 222     boolean isWritable([in]long column) raises (SQLException);
 223
 224     /** indicates whether a write on the column will definitely succeed.
 225         @param column
 226             the first column is 1, the second is 2,
 227         @returns
 228             `TRUE` if so
 229         @throws SQLException
 230             if a database access error occurs.
 231      */
 232     boolean isDefinitelyWritable([in]long column) raises (SQLException);
 233
 234     /** returns the fully-qualified name of the service whose instances
 235         are manufactured if the method
 236         com::sun::star::sdbc::XResultSet::.getObject()
 237         is called to retrieve a value from the column.
 238         @param column
 239             the first column is 1, the second is 2,
 240         @returns
 241             the service name
 242         @throws SQLException
 243             if a database access error occurs.
 244      */
 245     string getColumnServiceName([in]long column) raises (SQLException);
 246 };
 247
 248
 249 }; }; }; };
 250
 251 /*===========================================================================
 252 ===========================================================================*/
 253 #endif
 254
 255 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */