LibreOffice: com/sun/star/sdbc/XResultSetMetaData.idl Source File

LibreOffice LibreOffice 26.2 SDK API Reference

Loading...
Searching...
No Matches
XResultSetMetaData.idl
Go to the documentation of this file.
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
26published interface XResultSetMetaData: com::sun::star::uno::XInterface
27{
28
35 long getColumnCount() raises (SQLException);
36
45 boolean isAutoIncrement([in]long column) raises (SQLException);
46
55 boolean isCaseSensitive([in]long column) raises (SQLException);
56
65 boolean isSearchable([in]long column) raises (SQLException);
66
75 boolean isCurrency([in]long column) raises (SQLException);
76
85 long isNullable([in]long column) raises (SQLException);
86
95 boolean isSigned([in]long column) raises (SQLException);
96
105 long getColumnDisplaySize([in]long column) raises (SQLException);
106
116 string getColumnLabel([in]long column) raises (SQLException);
117
126 string getColumnName([in]long column) raises (SQLException);
127
136 string getSchemaName([in]long column) raises (SQLException);
137
146 long getPrecision([in]long column) raises (SQLException);
147
156 long getScale([in]long column) raises (SQLException);
157
166 string getTableName([in]long column) raises (SQLException);
167
176 string getCatalogName([in]long column) raises (SQLException);
177
186 long getColumnType([in]long column) raises (SQLException);
187
196 string getColumnTypeName([in]long column) raises (SQLException);
197
206 boolean isReadOnly([in]long column) raises (SQLException);
207
216 boolean isWritable([in]long column) raises (SQLException);
217
226 boolean isDefinitelyWritable([in]long column) raises (SQLException);
227
239 string getColumnServiceName([in]long column) raises (SQLException);
240};
241
242
243}; }; }; };
244
245/*===========================================================================
246===========================================================================*/
247
248/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::sdbc::SQLException
is an exception that provides information on a database access error.
Definition SQLException.idl:41
com::sun::star::sdbc::XResultSetMetaData
can be used to find out about the types and properties of the columns in a ResultSet.
Definition XResultSetMetaData.idl:27
com::sun::star::sdbc::XResultSetMetaData::isAutoIncrement
boolean isAutoIncrement([in]long column)
indicates whether the column is automatically numbered, thus read-only.
com::sun::star::sdbc::XResultSetMetaData::isDefinitelyWritable
boolean isDefinitelyWritable([in]long column)
indicates whether a write on the column will definitely succeed.
com::sun::star::sdbc::XResultSetMetaData::isReadOnly
boolean isReadOnly([in]long column)
indicates whether a column is definitely not writable.
com::sun::star::sdbc::XResultSetMetaData::getColumnDisplaySize
long getColumnDisplaySize([in]long column)
indicates the column's normal max width in chars.
com::sun::star::sdbc::XResultSetMetaData::getColumnName
string getColumnName([in]long column)
gets a column's name.
com::sun::star::sdbc::XResultSetMetaData::getSchemaName
string getSchemaName([in]long column)
gets a column's table's schema.
com::sun::star::sdbc::XResultSetMetaData::getColumnServiceName
string getColumnServiceName([in]long column)
returns the fully-qualified name of the service whose instances are manufactured if the method com::s...
com::sun::star::sdbc::XResultSetMetaData::getPrecision
long getPrecision([in]long column)
gets a column's number of decimal digits.
com::sun::star::sdbc::XResultSetMetaData::getColumnLabel
string getColumnLabel([in]long column)
gets the suggested column title for use in printouts and displays.
com::sun::star::sdbc::XResultSetMetaData::isCurrency
boolean isCurrency([in]long column)
indicates whether the column is a cash value.
com::sun::star::sdbc::XResultSetMetaData::isWritable
boolean isWritable([in]long column)
indicates whether it is possible for a write on the column to succeed.
com::sun::star::sdbc::XResultSetMetaData::getColumnCount
long getColumnCount()
returns the number of columns in this ResultSet.
com::sun::star::sdbc::XResultSetMetaData::getTableName
string getTableName([in]long column)
gets a column's table name.
com::sun::star::sdbc::XResultSetMetaData::getColumnType
long getColumnType([in]long column)
retrieves a column's SQL type.
com::sun::star::sdbc::XResultSetMetaData::isSearchable
boolean isSearchable([in]long column)
indicates whether the column can be used in a where clause.
com::sun::star::sdbc::XResultSetMetaData::isCaseSensitive
boolean isCaseSensitive([in]long column)
indicates whether a column's case matters.
com::sun::star::sdbc::XResultSetMetaData::isSigned
boolean isSigned([in]long column)
indicates whether values in the column are signed numbers.
com::sun::star::sdbc::XResultSetMetaData::isNullable
long isNullable([in]long column)
indicates the nullability of values in the designated column.
com::sun::star::sdbc::XResultSetMetaData::getColumnTypeName
string getColumnTypeName([in]long column)
retrieves a column's database-specific type name.
com::sun::star::sdbc::XResultSetMetaData::getCatalogName
string getCatalogName([in]long column)
gets a column's table's catalog name.
com::sun::star::sdbc::XResultSetMetaData::getScale
long getScale([in]long column)
gets a column's number of digits to right of the decimal point.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition XInterface.idl:46
com
Definition Ambiguous.idl:20