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

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