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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XGeneratedResultSet.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sdbc_XGeneratedResultSet_idl__
  31 #define __com_sun_star_sdbc_XGeneratedResultSet_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_sdbc_SQLException_idl__
  38 #include <com/sun/star/sdbc/SQLException.idl>
  39 #endif
  40
  41  module com {  module sun {  module star {  module sdbc {
  42
  43  published interface XResultSet;
  44
  45 /** provides a result set which gives access to automatically generated values after a new row was inserted.
  46
  47     The relative order of columns in the result set returned by getGeneratedValues must be the same as the relative order
  48     of the same columns as returned when executing a "SELECT * FROM table". This ensures that clients of this interface
  49     can reliably fetch the column values.
  50
  51     @see com::sun::star::sdbc::Statement
  52     @see com::sun::star::sdbc::PreparedStatement
  53     @since OOo 1.1.2
  54  */
  55 published interface XGeneratedResultSet: com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58     /** gives access to automatically generated values after a new row was inserted.
  59         @returns
  60             a result set that contains the data produced by the query
  61         @throws SQLException
  62             if a database access error occurs.
  63     */
  64     XResultSet getGeneratedValues() raises (SQLException);
  65
  66 };
  67
  68 //=============================================================================
  69
  70 }; }; }; };
  71
  72 /*===========================================================================
  73 ===========================================================================*/
  74 #endif