offapi/com/sun/star/sdbc/XResultSetMetaData.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_sdbc_XResultSetMetaData_idl__
  29 #define __com_sun_star_sdbc_XResultSetMetaData_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32
  33 #include <com/sun/star/sdbc/SQLException.idl>
  34
  35  module com {  module sun {  module star {  module sdbc {
  36
  37
  38 /** can be used to find out about the types and properties
  39     of the columns in a ResultSet.
  40  */
  41 published interface XResultSetMetaData: com::sun::star::uno::XInterface
  42 {
  43
  44     /** returns the number of columns in this ResultSet.
  45         @returns
  46             the column count
  47         @throws SQLException
  48             if a database access error occurs.
  49      */
  50     long getColumnCount() raises (SQLException);
  51     //-------------------------------------------------------------------------
  52
  53     /** indicates whether the column is automatically numbered, thus read-only.
  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 isAutoIncrement([in]long column) raises (SQLException);
  62     //-------------------------------------------------------------------------
  63
  64     /** indicates whether a column's case matters.
  65         @param column
  66             the first column is 1, the second is 2,
  67         @returns
  68             <TRUE/> if so
  69         @throws SQLException
  70             if a database access error occurs.
  71      */
  72     boolean isCaseSensitive([in]long column) raises (SQLException);
  73     //-------------------------------------------------------------------------
  74
  75     /** indicates whether the column can be used in a where clause.
  76         @param column
  77             the first column is 1, the second is 2,
  78         @returns
  79             <TRUE/> if so
  80         @throws SQLException
  81             if a database access error occurs.
  82      */
  83     boolean isSearchable([in]long column) raises (SQLException);
  84     //-------------------------------------------------------------------------
  85
  86     /** indicates whether the column is a cash value.
  87         @param column
  88             the first column is 1, the second is 2,
  89         @returns
  90             <TRUE/> if so
  91         @throws SQLException
  92             if a database access error occurs.
  93      */
  94     boolean isCurrency([in]long column) raises (SQLException);
  95     //-------------------------------------------------------------------------
  96
  97     /** indicates the nullability of values in the designated column.@see com::sun::star::sdbc::ColumnValue
  98         @param column
  99             the first column is 1, the second is 2,
 100         @returns
 101             <TRUE/> if so
 102         @throws SQLException
 103             if a database access error occurs.
 104      */
 105     long isNullable([in]long column) raises (SQLException);
 106     //-------------------------------------------------------------------------
 107
 108     /** indicates whether values in the column are signed numbers.
 109         @param column
 110             the first column is 1, the second is 2,
 111         @returns
 112             <TRUE/> if so
 113         @throws SQLException
 114             if a database access error occurs.
 115      */
 116     boolean isSigned([in]long column) raises (SQLException);
 117     //-------------------------------------------------------------------------
 118
 119     /** indicates the column's normal max width in chars.
 120         @param column
 121             the first column is 1, the second is 2,
 122         @returns
 123             the normal maximum number of characters allowed as the width of the designated column
 124         @throws SQLException
 125             if a database access error occurs.
 126      */
 127     long getColumnDisplaySize([in]long column) raises (SQLException);
 128     //-------------------------------------------------------------------------
 129
 130     /** gets the suggested column title for use in printouts and
 131         displays.
 132         @param column
 133             the first column is 1, the second is 2,
 134         @returns
 135             the suggested column title
 136         @throws SQLException
 137             if a database access error occurs.
 138      */
 139     string getColumnLabel([in]long column) raises (SQLException);
 140     //-------------------------------------------------------------------------
 141
 142     /** gets a column's name.
 143         @param column
 144             the first column is 1, the second is 2,
 145         @returns
 146             the column name
 147         @throws SQLException
 148             if a database access error occurs.
 149      */
 150     string getColumnName([in]long column) raises (SQLException);
 151     //-------------------------------------------------------------------------
 152
 153     /** gets a column's table's schema.
 154         @param column
 155             the first column is 1, the second is 2,
 156         @returns
 157             the schema name
 158         @throws SQLException
 159             if a database access error occurs.
 160      */
 161     string getSchemaName([in]long column) raises (SQLException);
 162     //-------------------------------------------------------------------------
 163
 164     /** gets a column's number of decimal digits.
 165         @param column
 166             the first column is 1, the second is 2,
 167         @returns
 168             precision
 169         @throws SQLException
 170             if a database access error occurs.
 171      */
 172     long getPrecision([in]long column) raises (SQLException);
 173     //-------------------------------------------------------------------------
 174
 175     /** gets a column's number of digits to right of the decimal point.
 176         @param column
 177             the first column is 1, the second is 2,
 178         @returns
 179             scale
 180         @throws SQLException
 181             if a database access error occurs.
 182      */
 183     long getScale([in]long column) raises (SQLException);
 184     //-------------------------------------------------------------------------
 185
 186     /** gets a column's table name.
 187         @param column
 188             the first column is 1, the second is 2,
 189         @returns
 190             the table name
 191         @throws SQLException
 192             if a database access error occurs.
 193      */
 194     string getTableName([in]long column) raises (SQLException);
 195     //-------------------------------------------------------------------------
 196
 197     /** gets a column's table's catalog name.
 198         @param column
 199             the first column is 1, the second is 2,
 200         @returns
 201             the catalog name
 202         @throws SQLException
 203             if a database access error occurs.
 204      */
 205     string getCatalogName([in]long column) raises (SQLException);
 206     //-------------------------------------------------------------------------
 207
 208     /** retrieves a column's SQL type.
 209         @param column
 210             the first column is 1, the second is 2,
 211         @returns
 212             the column type
 213         @throws SQLException
 214             if a database access error occurs.
 215      */
 216     long getColumnType([in]long column) raises (SQLException);
 217     //-------------------------------------------------------------------------
 218
 219     /** retrieves a column's database-specific type name.
 220         @param column
 221             the first column is 1, the second is 2,
 222         @returns
 223             the type name
 224         @throws SQLException
 225             if a database access error occurs.
 226      */
 227     string getColumnTypeName([in]long column) raises (SQLException);
 228     //-------------------------------------------------------------------------
 229
 230     /** indicates whether a column is definitely not writable.
 231         @param column
 232             the first column is 1, the second is 2,
 233         @returns
 234             <TRUE/> if so
 235         @throws SQLException
 236             if a database access error occurs.
 237      */
 238     boolean isReadOnly([in]long column) raises (SQLException);
 239     //-------------------------------------------------------------------------
 240
 241     /** indicates whether it is possible for a write on the column to succeed.
 242         @param column
 243             the first column is 1, the second is 2,
 244         @returns
 245             <TRUE/> if so
 246         @throws SQLException
 247             if a database access error occurs.
 248      */
 249     boolean isWritable([in]long column) raises (SQLException);
 250     //-------------------------------------------------------------------------
 251
 252     /** indicates whether a write on the column will definitely succeed.
 253         @param column
 254             the first column is 1, the second is 2,
 255         @returns
 256             <TRUE/> if so
 257         @throws SQLException
 258             if a database access error occurs.
 259      */
 260     boolean isDefinitelyWritable([in]long column) raises (SQLException);
 261     //-------------------------------------------------------------------------
 262
 263     /** returns the fully-qualified name of the service whose instances
 264         are manufactured if the method
 265         <member scope="com::sun::star::sdbc">XResultSet::.getObject()</member>
 266         is called to retrieve a value from the column.
 267         @param column
 268             the first column is 1, the second is 2,
 269         @returns
 270             the service name
 271         @throws SQLException
 272             if a database access error occurs.
 273      */
 274     string getColumnServiceName([in]long column) raises (SQLException);
 275 };
 276
 277 //=============================================================================
 278
 279 }; }; }; };
 280
 281 /*===========================================================================
 282 ===========================================================================*/
 283 #endif
 284
 285 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */