diff options
Diffstat (limited to 'offapi/com/sun/star/sdbc/XPreparedStatement.idl')
| -rw-r--r-- | offapi/com/sun/star/sdbc/XPreparedStatement.idl | 52 |
1 files changed, 42 insertions, 10 deletions
diff --git a/offapi/com/sun/star/sdbc/XPreparedStatement.idl b/offapi/com/sun/star/sdbc/XPreparedStatement.idl index fcb970aefc93..f6d7b6cbef00 100644 --- a/offapi/com/sun/star/sdbc/XPreparedStatement.idl +++ b/offapi/com/sun/star/sdbc/XPreparedStatement.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPreparedStatement.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,25 +79,38 @@ interface XResultSet; /** provides the possibilty of executing a precompiled SQL statement. - <p>A SQL statement is pre-compiled and stored in a PreparedStatement object. + <p> + A SQL statement is pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple - times.</p> + times. + </p> */ interface XPreparedStatement: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::XPreparedStatement::executeQuery - /** executes the SQL query in this <code>PreparedStatement</code> object - and returns the result set generated by the query. + /** executes the SQL query in this + <code>PreparedStatement</code> + object and returns the result set generated by the query. + @returns + the ResultSet object + @throws SQLException + if a database access error occurs. */ XResultSet executeQuery() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XPreparedStatement::executeUpdate /** executes the SQL INSERT, UPDATE or DELETE statement in this - <code>PreparedStatement</code> object.<br> + <type scope="com::sun::star::sdbc">PreparedStatement</type> + object. + <br/> In addition, SQL statements that return nothing, such as SQL DDL statements, can be executed. + @returns + either the row count for INSERT, UPDATE or DELETE statements; or 0 for SQL statements that return nothing + @throws SQLException + if a database access error occurs. */ long executeUpdate() raises (SQLException); //------------------------------------------------------------------------- @@ -106,17 +119,30 @@ interface XPreparedStatement: com::sun::star::uno::XInterface /** executes any kind of SQL statement. - <p>Some prepared statements return multiple results; the execute + <p> + Some prepared statements return multiple results; the execute method handles these complex statements as well as the simpler form of statements handled by executeQuery and executeUpdate. </p> + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean execute() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XPreparedStatement::getConnection - /** returns the <code>Connection</code> object - that produced this <code>Statement</code> object. + /** returns the + <type scope="com::sun::star::sdbc">Connection</type> + object + that produced this + <type scope="com::sun::star::sdbc">Statement</type> + object. + @returns + the Connection object + @throws SQLException + if a database access error occurs. */ XConnection getConnection() raises (SQLException); }; @@ -127,6 +153,12 @@ interface XPreparedStatement: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:35 mi moved from api |