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