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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20  module com {  module sun {  module star {  module sdbc {
  21
  22  published interface XResultSetMetaData;
  23
  24
  25 /** provides the possibility to find columns by their name.
  26
  27
  28     <p>
  29     When several columns have the same name, then the value
  30     of the first matching column will be returned. The column name option is
  31     designed to be used when column names are used in the SQL
  32     query. For columns that are NOT explicitly named in the query, it
  33     is best to use column numbers. If column names are used, there is
  34     no way for the programmer to guarantee that they actually refer to
  35     the intended columns.
  36     </p>
  37  */
  38 published interface XColumnLocate: com::sun::star::uno::XInterface
  39 {
  40
  41     /** maps the given ResultSet column name to its ResultSet column index.
  42
  43         <p>
  44         The specification before LibreOffice 4.2 left unspecified what should
  45         happen for an invalid column name. As a result some drivers written
  46         against the older specification may return a special invalid value, such
  47         as a negative number, zero, or a number greater than the number of
  48         columns.
  49         </p>
  50
  51         @param columnName
  52             the name of the column
  53         @returns
  54             the position of the column
  55         @throws SQLException
  56                 if the column named <code>columnName</code> does not exist,
  57                 or a database access error occurs.
  58      */
  59     long findColumn([in]string columnName) raises (SQLException);
  60 };
  61
  62
  63 }; }; }; };
  64
  65 /*===========================================================================
  66 ===========================================================================*/
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */