offapi/com/sun/star/sdbc/XColumnLocate.idl

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