update dev300-m58
[ooovba.git] / offapi / com / sun / star / sdbc / XColumnLocate.idl
blob3c8af927e65baa3619fe6b0c4826734e48685ff5
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XColumnLocate.idl,v $
10 * $Revision: 1.10 $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
30 #ifndef __com_sun_star_sdbc_XColumnLocate_idl__
31 #define __com_sun_star_sdbc_XColumnLocate_idl__
33 #ifndef __com_sun_star_uno_XInterface_idl__
34 #include <com/sun/star/uno/XInterface.idl>
35 #endif
37 #ifndef __com_sun_star_sdbc_SQLException_idl__
38 #include <com/sun/star/sdbc/SQLException.idl>
39 #endif
41 module com { module sun { module star { module sdbc {
43 published interface XResultSetMetaData;
46 /** provides the possibility to find columns by their name.
49 <p>
50 When several columns have the same name, then the value
51 of the first matching column will be returned. The column name option is
52 designed to be used when column names are used in the SQL
53 query. For columns that are NOT explicitly named in the query, it
54 is best to use column numbers. If column names are used, there is
55 no way for the programmer to guarantee that they actually refer to
56 the intended columns.
57 </p>
59 published interface XColumnLocate: com::sun::star::uno::XInterface
62 /** maps the given Resultset column name to its ResultSet column index.
63 @param columnName
64 the name of the column
65 @returns
66 the position of the column
67 @throws SQLException
68 if a database access error occurs.
70 long findColumn([in]string columnName) raises (SQLException);
71 };
73 //=============================================================================
75 }; }; }; };
77 /*===========================================================================
78 ===========================================================================*/
79 #endif