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