1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdbc_XColumnLocate_idl__
24#define __com_sun_star_sdbc_XColumnLocate_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_sdbc_SQLException_idl__
31#include <com/sun/star/sdbc/SQLException.idl>
32#endif
33
34 module com {  module sun {  module star {  module sdbc {
35
36 published interface XResultSetMetaData;
37
38
39/** provides the possibility to find columns by their name.
40
41
42	<p>
43	When several columns have the same name, then the value
44	of the first matching column will be returned. The column name option is
45	designed to be used when column names are used in the SQL
46	query. For columns that are NOT explicitly named in the query, it
47	is best to use column numbers. If column names are used, there is
48	no way for the programmer to guarantee that they actually refer to
49	the intended columns.
50	</p>
51 */
52published interface XColumnLocate: com::sun::star::uno::XInterface
53{
54
55	/** maps the given Resultset column name to its ResultSet column index.
56		@param columnName
57			the name of the column
58		@returns
59			the position of the column
60		@throws SQLException
61				if a database access error occurs.
62	 */
63	long findColumn([in]string columnName) raises (SQLException);
64};
65
66//=============================================================================
67
68}; }; }; };
69
70/*===========================================================================
71===========================================================================*/
72#endif
73