summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdbc/XGeneratedResultSet.idl
blob: 22f6ec00306edd98f4e43858f8f7f11e9042de4f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XGeneratedResultSet.idl,v $
 * $Revision: 1.10 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_sdbc_XGeneratedResultSet_idl__
#define __com_sun_star_sdbc_XGeneratedResultSet_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_sdbc_SQLException_idl__
#include <com/sun/star/sdbc/SQLException.idl>
#endif

 module com {  module sun {  module star {  module sdbc {

 published interface XResultSet;

/** provides a result set which gives access to automatically generated values after a new row was inserted.

    The relative order of columns in the result set returned by getGeneratedValues must be the same as the relative order
    of the same columns as returned when executing a "SELECT * FROM table". This ensures that clients of this interface
    can reliably fetch the column values.

    @see com::sun::star::sdbc::Statement
    @see com::sun::star::sdbc::PreparedStatement
    @since OOo 1.1.2
 */
published interface XGeneratedResultSet: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** gives access to automatically generated values after a new row was inserted.
        @returns
            a result set that contains the data produced by the query
        @throws SQLException
            if a database access error occurs.
    */
    XResultSet getGeneratedValues() raises (SQLException);

};

//=============================================================================

}; }; }; };

/*===========================================================================
===========================================================================*/
#endif