1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_sdbc_XResultSetMetaData_idl__ 24cdf0e10cSrcweir#define __com_sun_star_sdbc_XResultSetMetaData_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_sdbc_SQLException_idl__ 31cdf0e10cSrcweir#include <com/sun/star/sdbc/SQLException.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir module com { module sun { module star { module sdbc { 35cdf0e10cSrcweir 36cdf0e10cSrcweir 37cdf0e10cSrcweir/** can be used to find out about the types and properties 38cdf0e10cSrcweir of the columns in a ResultSet. 39cdf0e10cSrcweir */ 40cdf0e10cSrcweirpublished interface XResultSetMetaData: com::sun::star::uno::XInterface 41cdf0e10cSrcweir{ 42cdf0e10cSrcweir 43cdf0e10cSrcweir /** returns the number of columns in this ResultSet. 44cdf0e10cSrcweir @returns 45cdf0e10cSrcweir the column count 46cdf0e10cSrcweir @throws SQLException 47cdf0e10cSrcweir if a database access error occurs. 48cdf0e10cSrcweir */ 49cdf0e10cSrcweir long getColumnCount() raises (SQLException); 50cdf0e10cSrcweir //------------------------------------------------------------------------- 51cdf0e10cSrcweir 52cdf0e10cSrcweir /** indicates whether the column is automatically numbered, thus read-only. 53cdf0e10cSrcweir @param column 54cdf0e10cSrcweir the first column is 1, the second is 2, 55cdf0e10cSrcweir @returns 56cdf0e10cSrcweir <TRUE/> if so 57cdf0e10cSrcweir @throws SQLException 58cdf0e10cSrcweir if a database access error occurs. 59cdf0e10cSrcweir */ 60cdf0e10cSrcweir boolean isAutoIncrement([in]long column) raises (SQLException); 61cdf0e10cSrcweir //------------------------------------------------------------------------- 62cdf0e10cSrcweir 63cdf0e10cSrcweir /** indicates whether a column's case matters. 64cdf0e10cSrcweir @param column 65cdf0e10cSrcweir the first column is 1, the second is 2, 66cdf0e10cSrcweir @returns 67cdf0e10cSrcweir <TRUE/> if so 68cdf0e10cSrcweir @throws SQLException 69cdf0e10cSrcweir if a database access error occurs. 70cdf0e10cSrcweir */ 71cdf0e10cSrcweir boolean isCaseSensitive([in]long column) raises (SQLException); 72cdf0e10cSrcweir //------------------------------------------------------------------------- 73cdf0e10cSrcweir 74cdf0e10cSrcweir /** indicates whether the column can be used in a where clause. 75cdf0e10cSrcweir @param column 76cdf0e10cSrcweir the first column is 1, the second is 2, 77cdf0e10cSrcweir @returns 78cdf0e10cSrcweir <TRUE/> if so 79cdf0e10cSrcweir @throws SQLException 80cdf0e10cSrcweir if a database access error occurs. 81cdf0e10cSrcweir */ 82cdf0e10cSrcweir boolean isSearchable([in]long column) raises (SQLException); 83cdf0e10cSrcweir //------------------------------------------------------------------------- 84cdf0e10cSrcweir 85cdf0e10cSrcweir /** indicates whether the column is a cash value. 86cdf0e10cSrcweir @param column 87cdf0e10cSrcweir the first column is 1, the second is 2, 88cdf0e10cSrcweir @returns 89cdf0e10cSrcweir <TRUE/> if so 90cdf0e10cSrcweir @throws SQLException 91cdf0e10cSrcweir if a database access error occurs. 92cdf0e10cSrcweir */ 93cdf0e10cSrcweir boolean isCurrency([in]long column) raises (SQLException); 94cdf0e10cSrcweir //------------------------------------------------------------------------- 95cdf0e10cSrcweir 96cdf0e10cSrcweir /** indicates the nullability of values in the designated column.@see com::sun::star::sdbc::ColumnValue 97cdf0e10cSrcweir @param column 98cdf0e10cSrcweir the first column is 1, the second is 2, 99cdf0e10cSrcweir @returns 100cdf0e10cSrcweir <TRUE/> if so 101cdf0e10cSrcweir @throws SQLException 102cdf0e10cSrcweir if a database access error occurs. 103cdf0e10cSrcweir */ 104cdf0e10cSrcweir long isNullable([in]long column) raises (SQLException); 105cdf0e10cSrcweir //------------------------------------------------------------------------- 106cdf0e10cSrcweir 107cdf0e10cSrcweir /** indicates whether values in the column are signed numbers. 108cdf0e10cSrcweir @param column 109cdf0e10cSrcweir the first column is 1, the second is 2, 110cdf0e10cSrcweir @returns 111cdf0e10cSrcweir <TRUE/> if so 112cdf0e10cSrcweir @throws SQLException 113cdf0e10cSrcweir if a database access error occurs. 114cdf0e10cSrcweir */ 115cdf0e10cSrcweir boolean isSigned([in]long column) raises (SQLException); 116cdf0e10cSrcweir //------------------------------------------------------------------------- 117cdf0e10cSrcweir 118cdf0e10cSrcweir /** indicates the column's normal max width in chars. 119cdf0e10cSrcweir @param column 120cdf0e10cSrcweir the first column is 1, the second is 2, 121cdf0e10cSrcweir @returns 122cdf0e10cSrcweir the normal maximum number of characters allowed as the width of the designated column 123cdf0e10cSrcweir @throws SQLException 124cdf0e10cSrcweir if a database access error occurs. 125cdf0e10cSrcweir */ 126cdf0e10cSrcweir long getColumnDisplaySize([in]long column) raises (SQLException); 127cdf0e10cSrcweir //------------------------------------------------------------------------- 128cdf0e10cSrcweir 129cdf0e10cSrcweir /** gets the suggested column title for use in printouts and 130cdf0e10cSrcweir displays. 131cdf0e10cSrcweir @param column 132cdf0e10cSrcweir the first column is 1, the second is 2, 133cdf0e10cSrcweir @returns 134cdf0e10cSrcweir the suggested column title 135cdf0e10cSrcweir @throws SQLException 136cdf0e10cSrcweir if a database access error occurs. 137cdf0e10cSrcweir */ 138cdf0e10cSrcweir string getColumnLabel([in]long column) raises (SQLException); 139cdf0e10cSrcweir //------------------------------------------------------------------------- 140cdf0e10cSrcweir 141cdf0e10cSrcweir /** gets a column's name. 142cdf0e10cSrcweir @param column 143cdf0e10cSrcweir the first column is 1, the second is 2, 144cdf0e10cSrcweir @returns 145cdf0e10cSrcweir the column name 146cdf0e10cSrcweir @throws SQLException 147cdf0e10cSrcweir if a database access error occurs. 148cdf0e10cSrcweir */ 149cdf0e10cSrcweir string getColumnName([in]long column) raises (SQLException); 150cdf0e10cSrcweir //------------------------------------------------------------------------- 151cdf0e10cSrcweir 152cdf0e10cSrcweir /** gets a column's table's schema. 153cdf0e10cSrcweir @param column 154cdf0e10cSrcweir the first column is 1, the second is 2, 155cdf0e10cSrcweir @returns 156cdf0e10cSrcweir the schema name 157cdf0e10cSrcweir @throws SQLException 158cdf0e10cSrcweir if a database access error occurs. 159cdf0e10cSrcweir */ 160cdf0e10cSrcweir string getSchemaName([in]long column) raises (SQLException); 161cdf0e10cSrcweir //------------------------------------------------------------------------- 162cdf0e10cSrcweir 163cdf0e10cSrcweir /** gets a column's number of decimal digits. 164cdf0e10cSrcweir @param column 165cdf0e10cSrcweir the first column is 1, the second is 2, 166cdf0e10cSrcweir @returns 167cdf0e10cSrcweir precision 168cdf0e10cSrcweir @throws SQLException 169cdf0e10cSrcweir if a database access error occurs. 170cdf0e10cSrcweir */ 171cdf0e10cSrcweir long getPrecision([in]long column) raises (SQLException); 172cdf0e10cSrcweir //------------------------------------------------------------------------- 173cdf0e10cSrcweir 174cdf0e10cSrcweir /** gets a column's number of digits to right of the decimal point. 175cdf0e10cSrcweir @param column 176cdf0e10cSrcweir the first column is 1, the second is 2, 177cdf0e10cSrcweir @returns 178cdf0e10cSrcweir scale 179cdf0e10cSrcweir @throws SQLException 180cdf0e10cSrcweir if a database access error occurs. 181cdf0e10cSrcweir */ 182cdf0e10cSrcweir long getScale([in]long column) raises (SQLException); 183cdf0e10cSrcweir //------------------------------------------------------------------------- 184cdf0e10cSrcweir 185cdf0e10cSrcweir /** gets a column's table name. 186cdf0e10cSrcweir @param column 187cdf0e10cSrcweir the first column is 1, the second is 2, 188cdf0e10cSrcweir @returns 189cdf0e10cSrcweir the table name 190cdf0e10cSrcweir @throws SQLException 191cdf0e10cSrcweir if a database access error occurs. 192cdf0e10cSrcweir */ 193cdf0e10cSrcweir string getTableName([in]long column) raises (SQLException); 194cdf0e10cSrcweir //------------------------------------------------------------------------- 195cdf0e10cSrcweir 196cdf0e10cSrcweir /** gets a column's table's catalog name. 197cdf0e10cSrcweir @param column 198cdf0e10cSrcweir the first column is 1, the second is 2, 199cdf0e10cSrcweir @returns 200cdf0e10cSrcweir the catalog name 201cdf0e10cSrcweir @throws SQLException 202cdf0e10cSrcweir if a database access error occurs. 203cdf0e10cSrcweir */ 204cdf0e10cSrcweir string getCatalogName([in]long column) raises (SQLException); 205cdf0e10cSrcweir //------------------------------------------------------------------------- 206cdf0e10cSrcweir 207cdf0e10cSrcweir /** retrieves a column's SQL type. 208cdf0e10cSrcweir @param column 209cdf0e10cSrcweir the first column is 1, the second is 2, 210cdf0e10cSrcweir @returns 211cdf0e10cSrcweir the column type 212cdf0e10cSrcweir @throws SQLException 213cdf0e10cSrcweir if a database access error occurs. 214cdf0e10cSrcweir */ 215cdf0e10cSrcweir long getColumnType([in]long column) raises (SQLException); 216cdf0e10cSrcweir //------------------------------------------------------------------------- 217cdf0e10cSrcweir 218cdf0e10cSrcweir /** retrieves a column's database-specific type name. 219cdf0e10cSrcweir @param column 220cdf0e10cSrcweir the first column is 1, the second is 2, 221cdf0e10cSrcweir @returns 222cdf0e10cSrcweir the type name 223cdf0e10cSrcweir @throws SQLException 224cdf0e10cSrcweir if a database access error occurs. 225cdf0e10cSrcweir */ 226cdf0e10cSrcweir string getColumnTypeName([in]long column) raises (SQLException); 227cdf0e10cSrcweir //------------------------------------------------------------------------- 228cdf0e10cSrcweir 229cdf0e10cSrcweir /** indicates whether a column is definitely not writable. 230cdf0e10cSrcweir @param column 231cdf0e10cSrcweir the first column is 1, the second is 2, 232cdf0e10cSrcweir @returns 233cdf0e10cSrcweir <TRUE/> if so 234cdf0e10cSrcweir @throws SQLException 235cdf0e10cSrcweir if a database access error occurs. 236cdf0e10cSrcweir */ 237cdf0e10cSrcweir boolean isReadOnly([in]long column) raises (SQLException); 238cdf0e10cSrcweir //------------------------------------------------------------------------- 239cdf0e10cSrcweir 240cdf0e10cSrcweir /** indicates whether it is possible for a write on the column to succeed. 241cdf0e10cSrcweir @param column 242cdf0e10cSrcweir the first column is 1, the second is 2, 243cdf0e10cSrcweir @returns 244cdf0e10cSrcweir <TRUE/> if so 245cdf0e10cSrcweir @throws SQLException 246cdf0e10cSrcweir if a database access error occurs. 247cdf0e10cSrcweir */ 248cdf0e10cSrcweir boolean isWritable([in]long column) raises (SQLException); 249cdf0e10cSrcweir //------------------------------------------------------------------------- 250cdf0e10cSrcweir 251cdf0e10cSrcweir /** indicates whether a write on the column will definitely succeed. 252cdf0e10cSrcweir @param column 253cdf0e10cSrcweir the first column is 1, the second is 2, 254cdf0e10cSrcweir @returns 255cdf0e10cSrcweir <TRUE/> if so 256cdf0e10cSrcweir @throws SQLException 257cdf0e10cSrcweir if a database access error occurs. 258cdf0e10cSrcweir */ 259cdf0e10cSrcweir boolean isDefinitelyWritable([in]long column) raises (SQLException); 260cdf0e10cSrcweir //------------------------------------------------------------------------- 261cdf0e10cSrcweir 262cdf0e10cSrcweir /** returns the fully-qualified name of the service whose instances 263cdf0e10cSrcweir are manufactured if the method 264cdf0e10cSrcweir <member scope="com::sun::star::sdbc">XResultSet::.getObject()</member> 265cdf0e10cSrcweir is called to retrieve a value from the column. 266cdf0e10cSrcweir @param column 267cdf0e10cSrcweir the first column is 1, the second is 2, 268cdf0e10cSrcweir @returns 269cdf0e10cSrcweir the service name 270cdf0e10cSrcweir @throws SQLException 271cdf0e10cSrcweir if a database access error occurs. 272cdf0e10cSrcweir */ 273cdf0e10cSrcweir string getColumnServiceName([in]long column) raises (SQLException); 274cdf0e10cSrcweir}; 275cdf0e10cSrcweir 276cdf0e10cSrcweir//============================================================================= 277cdf0e10cSrcweir 278cdf0e10cSrcweir}; }; }; }; 279cdf0e10cSrcweir 280cdf0e10cSrcweir/*=========================================================================== 281cdf0e10cSrcweir===========================================================================*/ 282cdf0e10cSrcweir#endif 283