offapi/com/sun/star/sdbc/XGeneratedResultSet.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_XGeneratedResultSet_idl__
  28 #define __com_sun_star_sdbc_XGeneratedResultSet_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 XResultSet;
  41
  42 /** provides a result set which gives access to automatically generated values after a new row was inserted.
  43
  44     <p>The relative order of columns in the result set returned by <member>getGeneratedValues</member> must be the same
  45     as the relative order of the same columns as returned when executing a "SELECT * FROM table". This ensures that
  46     clients of this interface can reliably fetch the column values.</p>
  47
  48     @see com::sun::star::sdbc::Statement
  49     @see com::sun::star::sdbc::PreparedStatement
  50     @since OOo 1.1.2
  51  */
  52 published interface XGeneratedResultSet: com::sun::star::uno::XInterface
  53 {
  54     //-------------------------------------------------------------------------
  55     /** gives access to automatically generated values after a new row was inserted.
  56         @returns
  57             a result set that contains the data produced by the query
  58         @throws SQLException
  59             if a database access error occurs.
  60     */
  61     XResultSet getGeneratedValues() raises (SQLException);
  62
  63 };
  64
  65 //=============================================================================
  66
  67 }; }; }; };
  68
  69 /*===========================================================================
  70 ===========================================================================*/
  71 #endif