offapi/com/sun/star/sdbc/XGeneratedResultSet.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 #ifndef __com_sun_star_sdbc_XGeneratedResultSet_idl__
  20 #define __com_sun_star_sdbc_XGeneratedResultSet_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/sdbc/SQLException.idl>
  25
  26  module com {  module sun {  module star {  module sdbc {
  27
  28  published interface XResultSet;
  29
  30 /** provides a result set which gives access to automatically generated values after a new row was inserted.
  31
  32     <p>The relative order of columns in the result set returned by getGeneratedValues() must be the same
  33     as the relative order of the same columns as returned when executing a "SELECT * FROM table". This ensures that
  34     clients of this interface can reliably fetch the column values.</p>
  35
  36     @see com::sun::star::sdbc::Statement
  37     @see com::sun::star::sdbc::PreparedStatement
  38     @since OOo 1.1.2
  39  */
  40 published interface XGeneratedResultSet: com::sun::star::uno::XInterface
  41 {
  42     /** gives access to automatically generated values after a new row was inserted.
  43         @returns
  44             a result set that contains the data produced by the query
  45         @throws SQLException
  46             if a database access error occurs.
  47     */
  48     XResultSet getGeneratedValues() raises (SQLException);
  49
  50 };
  51
  52
  53 }; }; }; };
  54
  55 /*===========================================================================
  56 ===========================================================================*/
  57 #endif
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */