xref: /AOO41X/main/offapi/com/sun/star/sdbc/XColumnLocate.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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
10cdf0e10cSrcweir *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
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.
19cdf0e10cSrcweir *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_sdbc_XColumnLocate_idl__
24cdf0e10cSrcweir#define __com_sun_star_sdbc_XColumnLocate_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 published interface XResultSetMetaData;
37cdf0e10cSrcweir
38cdf0e10cSrcweir
39cdf0e10cSrcweir/** provides the possibility to find columns by their name.
40cdf0e10cSrcweir
41cdf0e10cSrcweir
42cdf0e10cSrcweir	<p>
43cdf0e10cSrcweir	When several columns have the same name, then the value
44cdf0e10cSrcweir	of the first matching column will be returned. The column name option is
45cdf0e10cSrcweir	designed to be used when column names are used in the SQL
46cdf0e10cSrcweir	query. For columns that are NOT explicitly named in the query, it
47cdf0e10cSrcweir	is best to use column numbers. If column names are used, there is
48cdf0e10cSrcweir	no way for the programmer to guarantee that they actually refer to
49cdf0e10cSrcweir	the intended columns.
50cdf0e10cSrcweir	</p>
51cdf0e10cSrcweir */
52cdf0e10cSrcweirpublished interface XColumnLocate: com::sun::star::uno::XInterface
53cdf0e10cSrcweir{
54cdf0e10cSrcweir
55cdf0e10cSrcweir	/** maps the given Resultset column name to its ResultSet column index.
56cdf0e10cSrcweir		@param columnName
57cdf0e10cSrcweir			the name of the column
58cdf0e10cSrcweir		@returns
59cdf0e10cSrcweir			the position of the column
60cdf0e10cSrcweir		@throws SQLException
61cdf0e10cSrcweir				if a database access error occurs.
62cdf0e10cSrcweir	 */
63cdf0e10cSrcweir	long findColumn([in]string columnName) raises (SQLException);
64cdf0e10cSrcweir};
65cdf0e10cSrcweir
66cdf0e10cSrcweir//=============================================================================
67cdf0e10cSrcweir
68cdf0e10cSrcweir}; }; }; };
69cdf0e10cSrcweir
70cdf0e10cSrcweir/*===========================================================================
71cdf0e10cSrcweir===========================================================================*/
72cdf0e10cSrcweir#endif
73