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