diff options
Diffstat (limited to 'offapi/com/sun/star/sdbc')
66 files changed, 4497 insertions, 980 deletions
diff --git a/offapi/com/sun/star/sdbc/BatchUpdateException.idl b/offapi/com/sun/star/sdbc/BatchUpdateException.idl index 4b8a1c4ac312..bf1ffa317b2b 100644 --- a/offapi/com/sun/star/sdbc/BatchUpdateException.idl +++ b/offapi/com/sun/star/sdbc/BatchUpdateException.idl @@ -2,9 +2,9 @@ * * $RCSfile: BatchUpdateException.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,8 +73,10 @@ <p>In addition to the information provided by - <type scope="com::sun::star::sdbc">SQLException</type>}, a - <code>BatchUpdateException</code> provides the update counts for all commands + <type scope="com::sun::star::sdbc">SQLException</type> + , a + <code>BatchUpdateException</code> + provides the update counts for all commands that were executed successfully during the batch update, that is, all commands that were executed before the error occurred. The order of elements in an array of update counts corresponds to the order in which commands were added @@ -84,9 +86,11 @@ exception BatchUpdateException: SQLException { // DocMerge from idl: field com::sun::star::sdbc::BatchUpdateException::UpdateCounts - /** is an array of <code>long</code>, with each element - indicating the update count for a SQL command that executed - successfully before the exception was thrown. + /** is an array of + <code>long</code> + , with each element + indicating the update count for a SQL command that executed + successfully before the exception was thrown. */ sequence<long> UpdateCounts; }; @@ -97,6 +101,12 @@ exception BatchUpdateException: SQLException /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:38 hjs initial import diff --git a/offapi/com/sun/star/sdbc/BestRowScope.idl b/offapi/com/sun/star/sdbc/BestRowScope.idl index ba8a6b3bd9c1..6bef5e0139a9 100644 --- a/offapi/com/sun/star/sdbc/BestRowScope.idl +++ b/offapi/com/sun/star/sdbc/BestRowScope.idl @@ -2,9 +2,9 @@ * * $RCSfile: BestRowScope.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,8 +75,12 @@ constants BestRowScope very temporary, lasting only while the row is being used. A possible value for the column <code>SCOPE</code> - in the <code>XResultSet</code> object - returned by the method <code>getBestRowIdentifier</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member>XDatabaseMetaData::getBestRowIdentifier()</member> + . */ const long TEMPORARY = 0; //------------------------------------------------------------------------- @@ -86,8 +90,12 @@ constants BestRowScope the remainder of the current transaction. A possible value for the column <code>SCOPE</code> - in the <code>XResultSet</code> object - returned by the method <code>getBestRowIdentifier</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member>XDatabaseMetaData::getBestRowIdentifier()</member> + . */ const long TRANSACTION = 1; //------------------------------------------------------------------------- @@ -97,8 +105,12 @@ constants BestRowScope the remainder of the current session. A possible value for the column <code>SCOPE</code> - in the <code>XResultSet</code> object - returned by the method <code>getBestRowIdentifier</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member>XDatabaseMetaData::getBestRowIdentifier()</member> + . */ const long SESSION = 2; }; @@ -109,6 +121,12 @@ constants BestRowScope /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:45 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/BestRowType.idl b/offapi/com/sun/star/sdbc/BestRowType.idl index 162e69150a74..d82ca650df42 100644 --- a/offapi/com/sun/star/sdbc/BestRowType.idl +++ b/offapi/com/sun/star/sdbc/BestRowType.idl @@ -2,9 +2,9 @@ * * $RCSfile: BestRowType.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,8 +74,12 @@ constants BestRowType /** indicates that the best row identifier may or may not be a pseudo-column. A possible value for the column <code>PSEUDO_COLUMN</code> - in the <code>XResultSet</code> object - returned by the method <code>getBestRowIdentifier</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member>XDatabaseMetaData::getBestRowIdentifier()</member> + . */ const long UNKNOWN = 0; //------------------------------------------------------------------------- @@ -84,8 +88,12 @@ constants BestRowType /** indicates that the best row identifier is NOT a pseudo-column. A possible value for the column <code>PSEUDO_COLUMN</code> - in the <code>XResultSet</code> object - returned by the method <code>getBestRowIdentifier</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member>XDatabaseMetaData::getBestRowIdentifier()</member> + . */ const long NOT_PSEUDO = 1; //------------------------------------------------------------------------- @@ -94,8 +102,12 @@ constants BestRowType /** indicates that the best row identifier is a pseudo-column. A possible value for the column <code>PSEUDO_COLUMN</code> - in the <code>XResultSet</code> object - returned by the method <code>getBestRowIdentifier</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member>XDatabaseMetaData::getBestRowIdentifier()</member> + . */ const long PSEUDO = 2; }; @@ -106,6 +118,12 @@ constants BestRowType /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:45 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/CallableStatement.idl b/offapi/com/sun/star/sdbc/CallableStatement.idl index 98a1661e492d..54024c0df33f 100644 --- a/offapi/com/sun/star/sdbc/CallableStatement.idl +++ b/offapi/com/sun/star/sdbc/CallableStatement.idl @@ -2,9 +2,9 @@ * * $RCSfile: CallableStatement.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,7 +75,8 @@ interface XOutParameters; /** is used to execute SQL stored procedures. - <p>SDBC provides a stored procedure SQL escape that allows stored procedures + <p> + SDBC provides a stored procedure SQL escape that allows stored procedures to be called in a standard way for all RDBMSs. This escape syntax has one form that includes a result parameter and one that does not. If used, the result parameter must be registered as an OUT parameter. The other parameters @@ -83,24 +84,42 @@ interface XOutParameters; by number. The first parameter is 1. </p> <p> - <code> - {?= call &lt;procedure-name&gt;[&lt;arg1&gt;,&lt;arg2&gt;, ...]} - {call &lt;procedure-name&gt;[&lt;arg1&gt;,&lt;arg2&gt;, ...]} + <code>{?=call&lt;procedure-name&gt;[&lt;arg1&gt;,&lt;arg2&gt;,...]}<br/>{call&lt;procedure-name&gt;[&lt;arg1&gt;,&lt;arg2&gt;,...]} </code> </p> - <p>IN parameter values are set using the set methods inherited from - <type scope="com::sun::star::sdbc">PreparedStatement</type>. The type of all + <p> + IN parameter values are set using the set methods inherited from + <type scope="com::sun::star::sdbc">PreparedStatement</type> + . The type of all OUT parameters must be registered prior to executing the stored procedure; - their values are retrieved after execution via the <code>get</code> methods - provided by the <type scope="com::sun::star::sdbc">XRow</type>.</p> - <p>A <code>CallableStatement</code> can return one - <type scope="com::sun::star::sdbc">XResultSet</type> or multiple - <code>ResultSet</code> objects. Multiple <code>ResultSet</code> objects are + their values are retrieved after execution via the + <code>get</code> + methods + provided by the + <type scope="com::sun::star::sdbc">XRow</type> + . + </p> + <p> + A + <code>CallableStatement</code> + can return one + <type scope="com::sun::star::sdbc">XResultSet</type> + or multiple + <type scope="com::sun::star::sdbc">ResultSet</type> + objects. Multiple + <code>ResultSet</code> + objects are handled using operations inherited from - <type scope="com::sun::star::sdbc">XPreparedStatement</type>.</p> - <p>For maximum portability, a call's <code>ResultSet</code> objects and + <type scope="com::sun::star::sdbc">XPreparedStatement</type> + . + </p> + <p> + For maximum portability, a call's + <type scope="com::sun::star::sdbc">ResultSet</type> + objects and update counts should be processed prior to getting the values of output - parameters.</p> + parameters. + </p> */ service CallableStatement { @@ -126,6 +145,12 @@ service CallableStatement /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:45 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/ChangeAction.idl b/offapi/com/sun/star/sdbc/ChangeAction.idl index ce21b669f4ba..398770e96647 100644 --- a/offapi/com/sun/star/sdbc/ChangeAction.idl +++ b/offapi/com/sun/star/sdbc/ChangeAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChangeAction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,7 +63,7 @@ module com { module sun { module star { module sdbc { -/** determines the type of the change which is going to be performed. +/** @deprecated determines the type of the change which is going to be performed. */ constants ChangeAction { diff --git a/offapi/com/sun/star/sdbc/ChangeEvent.idl b/offapi/com/sun/star/sdbc/ChangeEvent.idl index c36455b3451a..15899fd670cb 100644 --- a/offapi/com/sun/star/sdbc/ChangeEvent.idl +++ b/offapi/com/sun/star/sdbc/ChangeEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChangeEvent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,7 +67,7 @@ module com { module sun { module star { module sdbc { -/** indicates the type of change action on the data source. +/** @deprecated indicates the type of change action on the data source. */ struct ChangeEvent : com::sun::star::lang::EventObject { diff --git a/offapi/com/sun/star/sdbc/ColumnSearch.idl b/offapi/com/sun/star/sdbc/ColumnSearch.idl index 469ef49889bd..0b0d07b86d1e 100644 --- a/offapi/com/sun/star/sdbc/ColumnSearch.idl +++ b/offapi/com/sun/star/sdbc/ColumnSearch.idl @@ -2,9 +2,9 @@ * * $RCSfile: ColumnSearch.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,9 +73,14 @@ constants ColumnSearch // DocMerge from idl: value com::sun::star::sdbc::ColumnSearch::NONE /** A possible value for column <code>SEARCHABLE</code> in the - <code>XResultSet</code> object returned by the method - <code>getTypeInfo</code>. - <p>Indicates that <code>WHERE</code> search clauses are not supported + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member> + . + <p> + Indicates that + <code>WHERE</code> + search clauses are not supported for this type. */ const long NONE = 0; @@ -83,30 +88,51 @@ constants ColumnSearch // DocMerge from idl: value com::sun::star::sdbc::ColumnSearch::CHAR /** A possible value for column <code>SEARCHABLE</code> in the - <code>XResultSet</code> object returned by the method - <code>getTypeInfo</code>. - <p>Indicates that the only <code>WHERE</code> search clause that can - be based on this type is <code>WHERE . . .LIKE</code>. + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member> + . + <p> + Indicates that the only + <code>WHERE</code> + search clause that can + be based on this type is + <code>WHERE...LIKE</code> + . */ const long CHAR = 1; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::ColumnSearch::BASIC /** A possible value for column <code>SEARCHABLE</code> in the - <code>XResultSet</code> object returned by the method - <code>getTypeInfo</code>. - <p>Indicates that one can base all <code>WHERE</code> search clauses - except <code>WHERE . . .LIKE</code> on this data type. + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member> + . + <p> + Indicates that one can base all + <code>WHERE</code> + search clauses + except + <code>WHERE...LIKE</code> + on this data type. */ const long BASIC = 2; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::ColumnSearch::FULL - /** A possible value for column <code>SEARCHABLE</code> in the - <code>XResultSet</code> object returned by the method - <code>getTypeInfo</code>. - <p>Indicates that all <code>WHERE</code> search clauses can be - based on this type. + /** A possible value for column + <code>SEARCHABLE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member> + . + <p> + Indicates that all + <code>WHERE</code> + search clauses can be + based on this type. */ const long FULL = 3; }; @@ -117,6 +143,12 @@ constants ColumnSearch /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:39 hjs initial import diff --git a/offapi/com/sun/star/sdbc/ColumnType.idl b/offapi/com/sun/star/sdbc/ColumnType.idl index 6aa80e43799f..c9c16f85d1ea 100644 --- a/offapi/com/sun/star/sdbc/ColumnType.idl +++ b/offapi/com/sun/star/sdbc/ColumnType.idl @@ -2,9 +2,9 @@ * * $RCSfile: ColumnType.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,8 +74,12 @@ constants ColumnType /** indicates that this column may or may not be a pseudo-column. A possible value for the column <code>PSEUDO_COLUMN</code> - in the <code>XResultSet</code> object - returned by the method <code>getVersionColumns</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getVersionColumns()</member> + . */ const long UNKNOWN = 0; //------------------------------------------------------------------------- @@ -84,8 +88,12 @@ constants ColumnType /** indicates that this column is NOT a pseudo-column. A possible value for the column <code>PSEUDO_COLUMN</code> - in the <code>XResultSet</code> object - returned by the method <code>getVersionColumns</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getVersionColumns()</member> + . */ const long NOT_PSEUDO = 1; //------------------------------------------------------------------------- @@ -94,8 +102,12 @@ constants ColumnType /** indicates that this column is a pseudo-column. A possible value for the column <code>PSEUDO_COLUMN</code> - in the <code>XResultSet</code> object - returned by the method <code>getVersionColumns</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getVersionColumns()</member> + . */ const long PSEUDO = 2; }; @@ -106,6 +118,12 @@ constants ColumnType /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:45 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/Connection.idl b/offapi/com/sun/star/sdbc/Connection.idl index 41a111b4dc62..963fd0e2780b 100644 --- a/offapi/com/sun/star/sdbc/Connection.idl +++ b/offapi/com/sun/star/sdbc/Connection.idl @@ -2,9 +2,9 @@ * * $RCSfile: Connection.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,23 +76,27 @@ interface XWarningsSupplier; database. Within the context of a Connection, SQL statements are executed and results are returned. - - - <p>A Connection's database is able to provide information + <p> + A Connection's database is able to provide information describing its tables, its supported SQL grammar, its stored procedures, and the capabilities of this connection. This - information is obtained with the <code>getMetaData</code> method. - + information is obtained with the + <member scope="com::sun::star::sdbc">XConnection::getMetaData()</member> + method. </p> <p> - <b>Note:</b> By default the Connection automatically commits + <b> + Note: + </b> + By default the Connection automatically commits changes after executing each statement. If auto commit has been disabled, an explicit commit must be done or database changes will not be saved. - </p>@see com::sun::star::sdbc::XStatement - @see com::sun::star::sdbc::XResultSet - @see com::sun::star::sdbc::XDatabaseMetaData + </p> + @see com::sun::star::sdbc::XStatement + @see com::sun::star::sdbc::XResultSet + @see com::sun::star::sdbc::XDatabaseMetaData */ service Connection { @@ -123,6 +127,12 @@ service Connection /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:39 hjs initial import diff --git a/offapi/com/sun/star/sdbc/ConnectionPool.idl b/offapi/com/sun/star/sdbc/ConnectionPool.idl index ff4228a64b16..48a9d7ba3357 100644 --- a/offapi/com/sun/star/sdbc/ConnectionPool.idl +++ b/offapi/com/sun/star/sdbc/ConnectionPool.idl @@ -2,9 +2,9 @@ * * $RCSfile: ConnectionPool.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: oj $ $Date: 2001-04-26 10:40:22 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,16 +71,19 @@ interface XDriverManager; // DocMerge from xml: service com::sun::star::sdbc::ConnectionPool -/** is the basic service for pooling SDBC connections. +/** is the basic service for pooling SDBC connections. - </p> - <p>When the method <code>getConnection</code> is called, + <p> + When the method + <member scope="com::sun::star::sdbc">XPooledConnection::getConnection()</member> + is called, the ConnectionPool will attempt to locate a suitable pooled connection or create a new connection from the DriverManager. When the connection will be released it will move to the pool of unused connections. - </p>@see com::sun::star::sdbc::XDriver - @see com::sun::star::sdbc::XConnection + </p> + @see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XConnection */ service ConnectionPool { diff --git a/offapi/com/sun/star/sdbc/ConnectionProperties.idl b/offapi/com/sun/star/sdbc/ConnectionProperties.idl new file mode 100644 index 000000000000..68e236b8862d --- /dev/null +++ b/offapi/com/sun/star/sdbc/ConnectionProperties.idl @@ -0,0 +1,105 @@ +/************************************************************************* + * + * $RCSfile: ConnectionProperties.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:06:53 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_sdbc_ConnectionProperties_idl__ +#define __com_sun_star_sdbc_ConnectionProperties_idl__ + + module com { module sun { module star { module sdbc { + + + +/** represents the properties for a connection (session) with a specific + database. These properties can be used when calling the method + <member scope="com::sun::star::sdbc">XDriver::connect()</member> or + <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>. + + <p> + The properties for a connection contain additonal information about how to connect to a database and + how to control the behavior of the resulting connection should be. + + </p> + @see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::JDBCConnectionProperties + @see com::sun::star::sdbc::ODBCConnectionProperties + @see com::sun::star::sdbc::FILEConnectionProperties + @see com::sun::star::sdbc::DBASEConnectionProperties + @see com::sun::star::sdbc::FLATConnectionProperties + + */ +service ConnectionProperties +{ + /** the username + */ + [optional, property] string user; + + /** the password + */ + [optional, property] string password; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/DBASEConnectionProperties.idl b/offapi/com/sun/star/sdbc/DBASEConnectionProperties.idl new file mode 100644 index 000000000000..294c438651cc --- /dev/null +++ b/offapi/com/sun/star/sdbc/DBASEConnectionProperties.idl @@ -0,0 +1,100 @@ +/************************************************************************* + * + * $RCSfile: DBASEConnectionProperties.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:06:53 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_sdbc_DBASEConnectionProperties_idl__ +#define __com_sun_star_sdbc_DBASEConnectionProperties_idl__ + + module com { module sun { module star { module sdbc { + +#ifndef __com_sun_star_sdbc_FILEConnectionProperties_idl__ +#include <com/sun/star/sdbc/FILEConnectionProperties.idl> +#endif + +/** represents the properties for a dBase connection (session) with a specific + database. These properties can be used when calling the method + <member scope="com::sun::star::sdbc">XDriver::connect()</member> or + <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>. + + <p> + The properties for a connection contain additonal information about how to connect to a database and + how to control the behavior of the resulting connection should be. + + </p> + @see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::FILEConnectionProperties + */ +service DBASEConnectionProperties +{ + service com::sun::star::sdbc:: FILEConnectionProperties; + + /** <TRUE/> when deleted rows should be shown, otherwise <FALSE/> + */ + [optional, property] boolean ShowDeleted; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/DataTruncation.idl b/offapi/com/sun/star/sdbc/DataTruncation.idl index 627b51e194ff..cfe2d07f9bb7 100644 --- a/offapi/com/sun/star/sdbc/DataTruncation.idl +++ b/offapi/com/sun/star/sdbc/DataTruncation.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataTruncation.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,9 +72,13 @@ /** reports a DataTruncation warning, on reads, or is thrown as a DataTruncation exception, on writes, when a data value is unexpectedly truncated. - - - <p>The SQLstate for a <code>DataTruncation</code> is <code>01004</code>.</p> + <p> + The SQL state for a + <code>DataTruncation</code> + is + <code>01004</code> + . + </p> */ exception DataTruncation: SQLWarning { @@ -86,13 +90,17 @@ exception DataTruncation: SQLWarning // DocMerge from xml: field com::sun::star::sdbc::DataTruncation::IsParameter - /** is <TRUE/> if a parameter value is truncated. + /** is + <TRUE/> + if a parameter value is truncated. */ boolean IsParameter; // DocMerge from xml: field com::sun::star::sdbc::DataTruncation::DuringRead - /** is <TRUE/> if a read was truncated. + /** is + <TRUE/> + if a read was truncated. */ boolean DuringRead; @@ -100,14 +108,18 @@ exception DataTruncation: SQLWarning // DocMerge from xml: field com::sun::star::sdbc::DataTruncation::DataSize /** contains the number of bytes of data that should have been transferred. This number may be approximate if data conversions were being - performed. The value may be <code>-1</code> if the size is unknown. + performed. The value may be + <code>-1</code> + if the size is unknown. */ long DataSize; // DocMerge from xml: field com::sun::star::sdbc::DataTruncation::TransferSize /** contains the number of bytes of data actually transferred. - The value may be <code>-1</code> if the size is unknown. + The value may be + <code>-1</code> + if the size is unknown. */ long TransferSize; }; @@ -117,6 +129,12 @@ exception DataTruncation: SQLWarning }; }; }; }; /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.20.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.4 2000/12/14 12:53:39 mi + <true></true> -> <TRUE/> and same with FALSE + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/DataType.idl b/offapi/com/sun/star/sdbc/DataType.idl index b05288ecd440..917fa2b885fb 100644 --- a/offapi/com/sun/star/sdbc/DataType.idl +++ b/offapi/com/sun/star/sdbc/DataType.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,7 +68,13 @@ /** These constants are used to specify database data types which are used to identify the generic SQL types. The definition is based on JDBC 2.0. - <p>The actual type constant values are equivalent to those in the X/Open CLI. + <p> + The actual type constant values are equivalent to those in the X/Open CLI. + </p> + <p> + Precise information about the specfic types can be got from + <member>XDatabaseMetaData::getTypeInfo()</member> + .</p> */ constants DataType { @@ -136,7 +142,9 @@ constants DataType // DocMerge from idl: value com::sun::star::sdbc::DataType::OTHER /** indicates that the SQL type is database-specific and gets mapped to an object that can be accessed via - the method <member scope="com::sun::star::sql">XGetData::getObject()</member>. + the method + <member scope="com::sun::star::sdbc">XRow::getObject()</member> + . */ const long OTHER = 1111; @@ -192,6 +200,15 @@ constants DataType /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.2 2002/02/18 12:55:23 oj + #97563# parameter,return value and exception description + + Revision 1.3.24.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:39 hjs initial import diff --git a/offapi/com/sun/star/sdbc/Driver.idl b/offapi/com/sun/star/sdbc/Driver.idl index 858d750e5e3b..150ed330d8c1 100644 --- a/offapi/com/sun/star/sdbc/Driver.idl +++ b/offapi/com/sun/star/sdbc/Driver.idl @@ -2,9 +2,9 @@ * * $RCSfile: Driver.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,26 +69,29 @@ interface XDriver; // DocMerge from xml: service com::sun::star::sdbc::Driver /** is the service that every driver class must implement. - - - <p>Each driver should supply a service that implements + <p> + Each driver should supply a service that implements the Driver interface. </p> - <p>The DriverManager will try to load as many drivers as it can + <p> + The DriverManager will try to load as many drivers as it can find and then for any given connection request, it will ask each driver in turn to try to connect to the target URL. </p> - <p>It is strongly recommended that each Driver object should be + <p> + It is strongly recommended that each Driver object should be small and standalone so that the Driver object can be loaded and queried without bringing in vast quantities of supporting code. </p> - <p>Each driver should be a one instance service. + <p> + Each driver should be a one instance service. - </p>@see com::sun::star::sdbc::XDriverManager - @see com::sun::star::sdbc::XConnection + </p> + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::XConnection */ service Driver { @@ -105,6 +108,12 @@ service Driver /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:45 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/DriverManager.idl b/offapi/com/sun/star/sdbc/DriverManager.idl index ee6ae825225e..6f270c929c35 100644 --- a/offapi/com/sun/star/sdbc/DriverManager.idl +++ b/offapi/com/sun/star/sdbc/DriverManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: DriverManager.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,16 +76,19 @@ interface XDriverManager; /** is the basic service for managing a set of SDBC drivers. - <p>As part of its initialization, the DriverManager service will + <p> + As part of its initialization, the DriverManager service will attempt to load the registered drivers. </p> - <p>When the method <code>getConnection</code> is called, + <p> + When the method <code>getConnection</code> is called, the DriverManager will attempt to locate a suitable driver. - </p>@see com::sun::star::sdbc::XDriver - @see com::sun::star::sdbc::XConnection + </p> + @see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XConnection */ service DriverManager { @@ -107,6 +110,12 @@ service DriverManager /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:45 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl b/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl index 99603e1fd91a..f12ef061d541 100644 --- a/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl +++ b/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: DriverPropertyInfo.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,9 +68,11 @@ /** describes the driver properties for making a connection. - <p>The DriverPropertyInfo is of interest only to advanced programmers + <p> + The DriverPropertyInfo is of interest only to advanced programmers who need to interact with a driver to discover and supply properties - for connections.</p> + for connections. + </p> */ struct DriverPropertyInfo { @@ -87,8 +89,14 @@ struct DriverPropertyInfo // DocMerge from xml: field com::sun::star::sdbc::DriverPropertyInfo::IsRequired - /** is <TRUE/> if a value must be supplied for this property - during <code>Driver.connect</code> and <FALSE/> otherwise. + /** is + <TRUE/> + if a value must be supplied for this property + during + <code>Driver.connect</code> + and + <FALSE/> + otherwise. */ boolean IsRequired; @@ -103,8 +111,9 @@ struct DriverPropertyInfo // DocMerge from idl: field com::sun::star::sdbc::DriverPropertyInfo::Choices /** contains a sequence of possible values if the value for the field - <code>DriverPropertyInfo.value</code> may be selected - from a particular set of values; otherwise empty. + <code>DriverPropertyInfo.value</code> + may be selected + from a particular set of values; otherwise empty. */ sequence<string> Choices; }; @@ -115,6 +124,12 @@ struct DriverPropertyInfo /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.20.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.4 2000/12/14 12:53:39 mi + <true></true> -> <TRUE/> and same with FALSE + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/FILEConnectionProperties.idl b/offapi/com/sun/star/sdbc/FILEConnectionProperties.idl new file mode 100644 index 000000000000..2c29933846e8 --- /dev/null +++ b/offapi/com/sun/star/sdbc/FILEConnectionProperties.idl @@ -0,0 +1,99 @@ +/************************************************************************* + * + * $RCSfile: FILEConnectionProperties.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:06:55 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_sdbc_FILEConnectionProperties_idl__ +#define __com_sun_star_sdbc_FILEConnectionProperties_idl__ + + module com { module sun { module star { module sdbc { + +#ifndef __com_sun_star_sdbc_ConnectionProperties_idl__ +#include <com/sun/star/sdbc/ConnectionProperties.idl> +#endif + +/** represents the properties for a FILE connection (session) with a specific + database. These properties can be used when calling the method + <member scope="com::sun::star::sdbc">XDriver::connect()</member> or + <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>. + + <p> + The properties for a connection contain additonal information about how to connect to a database and + how to control the behavior of the resulting connection should be. + + </p> + @see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::ConnectionProperties + */ +service FILEConnectionProperties +{ + service com::sun::star::sdbc::ConnectionProperties; + /** which charset should be used to fetch data. + */ + [optional, property] long Charset; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/FLATConnectionProperties.idl b/offapi/com/sun/star/sdbc/FLATConnectionProperties.idl new file mode 100644 index 000000000000..3d86d7a47084 --- /dev/null +++ b/offapi/com/sun/star/sdbc/FLATConnectionProperties.idl @@ -0,0 +1,120 @@ +/************************************************************************* + * + * $RCSfile: FLATConnectionProperties.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:06:55 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_sdbc_FLATConnectionProperties_idl__ +#define __com_sun_star_sdbc_FLATConnectionProperties_idl__ + + module com { module sun { module star { module sdbc { + +#ifndef __com_sun_star_sdbc_FILEConnectionProperties_idl__ +#include <com/sun/star/sdbc/FILEConnectionProperties.idl> +#endif + +/** represents the properties for a FLAT connection (session) with a specific + database. These properties can be used when calling the method + <member scope="com::sun::star::sdbc">XDriver::connect()</member> or + <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>. + + <p> + The properties for a connection contain additonal information about how to connect to a database and + how to control the behavior of the resulting connection should be. + + </p> + @see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::FILEConnectionProperties + */ +service FLATConnectionProperties +{ + service com::sun::star::sdbc::FILEConnectionProperties; + + /** <TRUE/> when the file contains a header line otherwise <FALSE/> + */ + [optional, property] boolean HeaderLine; + + /** A one character delimiter to seperate the fields. + */ + [optional, property] string FieldDelimiter; + + /** A one character delimiter to seperate the strings. + */ + [optional, property] string StringDelimiter; + + /** A one character delimiter to seperate the decimal. + */ + [optional, property] string DecimalDelimiter; + + /** A one character delimiter to seperate the thousands. + */ + [optional, property] string ThousandDelimiter; + + /** the extension of the files to be used. + */ + [property] string Extension; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/IndexType.idl b/offapi/com/sun/star/sdbc/IndexType.idl index 2a09737294dd..fe36c362488e 100644 --- a/offapi/com/sun/star/sdbc/IndexType.idl +++ b/offapi/com/sun/star/sdbc/IndexType.idl @@ -2,9 +2,9 @@ * * $RCSfile: IndexType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,40 +71,64 @@ constants IndexType { // DocMerge from idl: value com::sun::star::sdbc::IndexType::STATISTIC - /** A possible value for column <code>TYPE</code> in the - <code>XResultSet</code> object returned by the method - <code>getIndexInfo</code>. - <P>Indentifies table statistics that are returned in conjunction - with a table's index description. + /** A possible value for column + <code>TYPE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getIndexInfo()</member> + . + <P> + Indentifies table statistics that are returned in conjunction + with a table's index description. + </P> */ const short STATISTIC = 0; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::IndexType::CLUSTERED - /** A possible value for column <code>TYPE</code> in the - <code>XResultSet</code> object returned by the method - <code>getIndexInfo</code>. - <P>Indicates that this table index is a clustered index. + /** A possible value for column + <code>TYPE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getIndexInfo()</member> + . + <P> + Indicates that this table index is a clustered index. + </P> */ const short CLUSTERED = 1; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::IndexType::HASHED - /** A possible value for column <code>TYPE</code> in the - <code>XResultSet</code> object returned by the method - <code>getIndexInfo</code>. - <P>Indicates that this table index is a hashed index. + /** A possible value for column + <code>TYPE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getIndexInfo()</member> + . + <P> + Indicates that this table index is a hashed index. + </P> */ const short HASHED = 2; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::IndexType::OTHER - /** A possible value for column <code>TYPE</code> in the - <code>XResultSet</code> object returned by the method - <code>getIndexInfo</code>. - <P>Indicates that this table index is not a clustered + /** A possible value for column + <code>TYPE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getIndexInfo()</member> + . + <P> + Indicates that this table index is not a clustered index, a hashed index, or table statistics; it is something other than these. + </P> */ const short OTHER = 3; }; @@ -115,6 +139,12 @@ constants IndexType /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:40 hjs initial import diff --git a/offapi/com/sun/star/sdbc/JDBCConnectionProperties.idl b/offapi/com/sun/star/sdbc/JDBCConnectionProperties.idl new file mode 100644 index 000000000000..3ad73b868fc8 --- /dev/null +++ b/offapi/com/sun/star/sdbc/JDBCConnectionProperties.idl @@ -0,0 +1,112 @@ +/************************************************************************* + * + * $RCSfile: JDBCConnectionProperties.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:06:55 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_sdbc_JDBCConnectionProperties_idl__ +#define __com_sun_star_sdbc_JDBCConnectionProperties_idl__ + + module com { module sun { module star { module sdbc { + +#ifndef __com_sun_star_sdbc_ConnectionProperties_idl__ +#include <com/sun/star/sdbc/ConnectionProperties.idl> +#endif + +/** represents the properties for a JDBC connection (session) with a specific + database. These properties can be used when calling the method + <member scope="com::sun::star::sdbc">XDriver::connect()</member> or + <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>. + + <p> + The properties for a connection contain additonal information about how to connect to a database and + how to control the behavior of the resulting connection should be. + + </p> + @see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::ConnectionProperties + */ +service JDBCConnectionProperties +{ + service com::sun::star::sdbc::ConnectionProperties; + + /** which jdbc driver class should be loaded to create the connection. + */ + [optional, property] string JavaDriverClass; + + /** specifies if retrieving of auto generated values should be enabled or not. + If <TRUE/> than the statement will support the XGeneratedResultSet interface, otherwise not. + @see com::sun::star::sdbc::XGeneratedResultSet + */ + [optional, property] boolean IsAutoRetrievingEnabled; + + /** specifies the statement which should be executed + when asking an "INSERT" statement for the XGeneratedResultSet interface. + @see com::sun::star::sdbc::XGeneratedResultSet + */ + [optional, property] string AutoRetrievingStatement; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/KeyRule.idl b/offapi/com/sun/star/sdbc/KeyRule.idl index 8157c9269181..14f5b6b328d7 100644 --- a/offapi/com/sun/star/sdbc/KeyRule.idl +++ b/offapi/com/sun/star/sdbc/KeyRule.idl @@ -2,9 +2,9 @@ * * $RCSfile: KeyRule.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,79 +71,154 @@ constants KeyRule { // DocMerge from idl: value com::sun::star::sdbc::KeyRule::CASCADE - /** a possible value for the column's <code>UPDATE_RULE</code> - and <code>DELETE_RULE</code> in the - <code>XResultSet</code> objects returned by the methods - <code>getImportedKeys</code>, <code>getExportedKeys</code>, - and <code>getCrossReference</code>. - <P>For the column <code>UPDATE_RULE</code>, + /** a possible value for the column's + <code>UPDATE_RULE</code> + and + <code>DELETE_RULE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + objects returned by the methods + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member> + , + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member> + , + and + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member> + . + <P> + For the column + <code>UPDATE_RULE</code> + , it indicates that when the primary key is updated, the foreign key (imported key) is changed to agree with it. - <P>For the column <code>DELETE_RULE</code>, + </P> + <P> + For the column + <code>DELETE_RULE</code> + , it indicates that when the primary key is deleted, rows that imported that key are deleted. + </P> */ const long CASCADE = 0; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::KeyRule::RESTRICT - /** a possible value for the column's <code>UPDATE_RULE</code> - and <code>DELETE_RULE</code> in the - <code>XResultSet</code> objects returned by the methods - <code>getImportedKeys</code>, <code>getExportedKeys</code>, - and <code>getCrossReference</code>. - <P>For the column <code>UPDATE_RULE</code>, it indicates that + /** a possible value for the column's + <code>UPDATE_RULE</code> + and + <code>DELETE_RULE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + objects returned by the methods + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member> + , + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member> + , + and + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member> + . + <P> + For the column + <code>UPDATE_RULE</code> + , it indicates that a primary key may not be updated if it has been imported by another table as a foreign key. - <P>For the column <code>DELETE_RULE</code>, it indicates that + </P> + <P> + For the column + <code>DELETE_RULE</code> + , it indicates that a primary key may not be deleted if it has been imported by another table as a foreign key. + </P> */ const long RESTRICT = 1; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::KeyRule::SET_NULL - /** a possible value for the column's <code>UPDATE_RULE</code> - and <code>DELETE_RULE</code> in the - <code>XResultSet</code> objects returned by the methods - <code>getImportedKeys</code>, <code>getExportedKeys</code>, - and <code>getCrossReference</code>. - <P>For the columns <code>UPDATE_RULE</code> - and <code>DELETE_RULE</code>, + /** a possible value for the column's + <code>UPDATE_RULE</code> + and + <code>DELETE_RULE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + objects returned by the methods + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member> + , + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member> + , + and + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member> + . + <P> + For the columns + <code>UPDATE_RULE</code> + and + <code>DELETE_RULE</code> + , it indicates that when the primary key is updated or deleted, the foreign key (imported key) is changed to <code>NULL</code>. + </P> */ const long SET_NULL = 2; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::KeyRule::NO_ACTION - /** a possible value for the column's <code>UPDATE_RULE</code> - and <code>DELETE_RULE</code> in the - <code>XResultSet</code> objects returned by the methods - <code>getImportedKeys</code>, <code>getExportedKeys</code>, - and <code>getCrossReference</code>. - <P>For the columns <code>UPDATE_RULE</code> - and <code>DELETE_RULE</code>, - it indicates that - if the primary key has been imported, it cannot be updated or deleted. + /** a possible value for the column's + <code>UPDATE_RULE</code> + and + <code>DELETE_RULE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + objects returned by the methods + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member> + , + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member> + , + and + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member> + . + <P> + For the columns + <code>UPDATE_RULE</code> + and + <code>DELETE_RULE</code> + , + it indicates that if the primary key has been imported, it cannot be updated or deleted. + </P> */ const long NO_ACTION = 3; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::KeyRule::SET_DEFAULT - /** a possible value for the column's <code>UPDATE_RULE</code> - and <code>DELETE_RULE</code> in the - <code>XResultSet</code> objects returned by the methods - <code>getImportedKeys</code>, <code>getExportedKeys</code>, - and <code>getCrossReference</code>. - <P>For the columns <code>UPDATE_RULE</code> - and <code>DELETE_RULE</code>, + /** a possible value for the column's + <code>UPDATE_RULE</code> + and + <code>DELETE_RULE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + objects returned by the methods + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member> + , + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member> + , + and + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member> + . + <P> + For the columns + <code>UPDATE_RULE</code> + and + <code>DELETE_RULE</code> + , it indicates that if the primary key is updated or deleted, the foreign key (imported key) is set to the default value. + </P> */ const long SET_DEFAULT = 4; }; @@ -154,6 +229,12 @@ constants KeyRule /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:45 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/ODBCConnectionProperties.idl b/offapi/com/sun/star/sdbc/ODBCConnectionProperties.idl new file mode 100644 index 000000000000..a52418b745d2 --- /dev/null +++ b/offapi/com/sun/star/sdbc/ODBCConnectionProperties.idl @@ -0,0 +1,127 @@ +/************************************************************************* + * + * $RCSfile: ODBCConnectionProperties.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:06:56 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_sdbc_ODBCConnectionProperties_idl__ +#define __com_sun_star_sdbc_ODBCConnectionProperties_idl__ + + module com { module sun { module star { module sdbc { + +#ifndef __com_sun_star_sdbc_ConnectionProperties_idl__ +#include <com/sun/star/sdbc/ConnectionProperties.idl> +#endif + +/** represents the properties for a ODBC connection (session) with a specific + database. These properties can be used when calling the method + <member scope="com::sun::star::sdbc">XDriver::connect()</member> or + <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>. + + <p> + The properties for a connection contain additonal information about how to connect to a database and + how to control the behavior of the resulting connection should be. + + </p> + @see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::ConnectionProperties + */ +service ODBCConnectionProperties +{ + service com::sun::star::sdbc::ConnectionProperties; + /** should the parameter '?' in prepared statement be substituated with an distinct name + */ + [optional, property] boolean ParameterNameSubstitution; + + /** the Timeout after which time a timeout should happen + */ + [optional, property] long Timeout; + + /** Silent - should the connection be silent. No user interaction while creating the connection. + */ + [optional, property] boolean Silent; + + /** should the driver should support a catalog. + */ + [optional, property] boolean UseCatalog; + + /** which charset should be used to fetch data. + */ + [optional, property] long Charset; + + /** specifies if retrieving of auto generated values should be enabled or not. + If <TRUE/> than the statement will support the XGeneratedResultSet interface, otherwise not. + @see com::sun::star::sdbc::XGeneratedResultSet + */ + [optional, property] boolean IsAutoRetrievingEnabled; + + /** specifies the statement which should be executed + when asking an "INSERT" statement for the XGeneratedResultSet interface. + @see com::sun::star::sdbc::XGeneratedResultSet + */ + [optional, property] string AutoRetrievingStatement; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/PreparedStatement.idl b/offapi/com/sun/star/sdbc/PreparedStatement.idl index c9c085456c02..e5f5059df483 100644 --- a/offapi/com/sun/star/sdbc/PreparedStatement.idl +++ b/offapi/com/sun/star/sdbc/PreparedStatement.idl @@ -2,9 +2,9 @@ * * $RCSfile: PreparedStatement.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: oj $ $Date: 2002-07-19 11:16:37 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,17 +87,30 @@ interface XGeneratedResultSet; // DocMerge from idl: service com::sun::star::sdbc::PreparedStatement /** represents 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><B>Note:</B> The setXXX methods for setting IN parameter values + </P> + <P> + <B> + Note: + </B> + The + <code>setXXX</code> + methods for setting IN parameter values must specify types that are compatible with the defined SQL type of the input parameter. For instance, if the IN parameter has SQL type - Integer, then the method <code>setLong</code> should be used. - - <p>If arbitrary parameter type conversions are required, the method - <code>setObject</code> should be used with a target SQL type. - <br> + Integer, then the method + <member scope="com::sun::star::sdbc">XParameters::setInt()</member> + should be used. + </P> + <p> + If arbitrary parameter type conversions are required, the method + <member scope="com::sun::star::sdbc">XParameters::setObject()</member> + should be used with a target SQL type. + </p> + <p> Example of setting a parameter; <code>con</code> is an active connection. @example:StarBASIC <listing> @@ -105,11 +118,19 @@ interface XGeneratedResultSet; pstmt.setDouble(1, 153833.00) pstmt.setLong(2, 110592) </listing> - <P>Only one ResultSet per Statement can be open at any point in + </p> + <P> + Only one + <type scope="com::sun::star::sdbc">ResultSet</type> + per + <type scope="com::sun::star::sdbc">Statement</type> + can be open at any point in time. Therefore, if the reading of one ResultSet is interleaved with the reading of another, each must have been generated by - different Statements. All statement <code>execute</code> methods implicitly - close a statement's current ResultSet if an open one exists. + different Statements. All statement + <code>execute</code> + methods implicitly close a statement's current ResultSet if an open one exists. + </p> */ service PreparedStatement { @@ -127,7 +148,7 @@ service PreparedStatement */ interface XCloseable; - // DocMerge: empty anyway + // gives access to the properties. interface com::sun::star::beans::XPropertySet; // DocMerge from xml: service com::sun::star::sdbc::PreparedStatement: interface com::sun::star::util::XCancellable @@ -166,9 +187,12 @@ service PreparedStatement // DocMerge from xml: service com::sun::star::sdbc::PreparedStatement: interface com::sun::star::sdbc::XPreparedBatchExecution /** provides the ability of batch execution. This interface is optional for execution. - <p>A driver implementing batch execution must return <TRUE/> for - <member scope= "com::sun::star::sdbc"> - XDatabaseMetaData::supportsBatchUpdates()</member> + <p> + A driver implementing batch execution must return + <TRUE/> + for + <member scope= "com::sun::star::sdbc">XDatabaseMetaData::supportsBatchUpdates()</member> + </p> */ [optional] interface XPreparedBatchExecution; @@ -197,11 +221,27 @@ service PreparedStatement // DocMerge from idl: property com::sun::star::sdbc::PreparedStatement::MaxFieldSize /** returns the maximum number of bytes allowed for any column value. - <p>This limit is the maximum number of bytes that can be returned - for any column value. The limit applies only to BINARY, - VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR columns. + <p> + This limit is the maximum number of bytes that can be returned + for any column value. The limit applies only to + <member scope= "com::sun::star::sdbc">DataType::BINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::VARBINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::LONGVARBINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::CHAR</member> + , + <member scope= "com::sun::star::sdbc">DataType::VARCHAR</member> + , + and + <member scope= "com::sun::star::sdbc">DataType::LONGVARCHAR</member> + columns. If the limit is exceeded, the excess data is silently discarded. - <br>There is no limitation, if set to zero. + </p> + <p> + There is no limitation, if set to zero. + </p> */ [property] long MaxFieldSize; @@ -216,18 +256,26 @@ service PreparedStatement // DocMerge from idl: property com::sun::star::sdbc::PreparedStatement::CursorName /** defines the SQL cursor name that will be used by subsequent Statement - <code>execute</code> methods. - <p>This name can then be used in SQL positioned update/delete statements to + <code>execute</code> + methods. + <p> + This name can then be used in SQL positioned update/delete statements to identify the current row in the ResultSet generated by this statement. If the database does not support positioned update/delete, this property is a noop. To insure that a cursor has the proper isolation level to support updates, the cursor's SELECT statement should be of the form 'select for update ...'. If the 'for update' phrase is omitted, positioned updates may fail. - <P><B>Note:</B> By definition, positioned update/delete + </p> + <P> + <B> + Note: + </B> + By definition, positioned update/delete execution must be done by a different Statement than the one which generated the ResultSet being used for positioning. Also, cursor names must be unique within a connection. + </p> */ [property] string CursorName; @@ -249,18 +297,29 @@ service PreparedStatement // DocMerge from idl: property com::sun::star::sdbc::PreparedStatement::FetchDirection /** retrieves the direction for fetching rows from database tables that is the default for result sets generated from this - <code>Statement</code> object.<br> - If this <code>Statement</code> object has not set a fetch direction, + <code>Statement</code> + object. + <p> + If this + <code>Statement</code> + object has not set a fetch direction, the return value is implementation-specific. + </p> */ [property] long FetchDirection; // DocMerge from idl: property com::sun::star::sdbc::PreparedStatement::FetchSize /** retrieves the number of result set rows that is the default fetch size - for result sets generated from this <code>Statement</code> object.<br> - If this <code>Statement</code> object has not set a fetch size, + for result sets generated from this + <code>Statement</code> + object. + <p> + If this + <code>Statement</code> + object has not set a fetch size, the return value is implementation-specific. + </p> */ [property] long FetchSize; }; @@ -269,40 +328,4 @@ service PreparedStatement }; }; }; }; -/*=========================================================================== - $Log: not supported by cvs2svn $ - Revision 1.8 2002/07/19 10:09:03 oj - #95146# new interface to query for autogenerated values - - Revision 1.7 2001/11/01 16:46:46 mi - proofreading and corrections from Richard Holt - - Revision 1.6 2001/02/20 13:30:07 fs - #82875# removed XClearParameters - this interface is obsolete, the functionality is covered by XParameters - - Revision 1.5 2001/01/23 10:08:28 mi - optional interfaces now marked as [optional] instead of just a prosa description of this fact - - Revision 1.4 2000/12/19 16:03:44 mi - documentations syntax errors fixed - - Revision 1.3 2000/11/08 12:43:35 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:40 hjs - initial import - - Revision 1.5 2000/09/11 11:52:42 mi - documentation merged from XML - - Revision 1.3 1999/12/20 16:11:34 dg - #70278# changes in API - - Revision 1.2 1999/12/14 12:05:45 dg - #70278# CompareBookmark removed - - Revision 1.1 1999/11/24 08:41:01 dg - new StarDataBaseConnectivity - -===========================================================================*/ #endif diff --git a/offapi/com/sun/star/sdbc/ProcedureColumn.idl b/offapi/com/sun/star/sdbc/ProcedureColumn.idl index d89b526f27a1..fb868660e4b7 100644 --- a/offapi/com/sun/star/sdbc/ProcedureColumn.idl +++ b/offapi/com/sun/star/sdbc/ProcedureColumn.idl @@ -2,9 +2,9 @@ * * $RCSfile: ProcedureColumn.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,8 +72,13 @@ constants ProcedureColumn // DocMerge from idl: value com::sun::star::sdbc::ProcedureColumn::UNKNOWN /** indicates that the type of the column is unknown. A possible value for - the column <code>COLUMN_TYPE</code> in the <code>XResultSet</code> - returned by the method <code>getProcedureColumns</code>. + the column + <code>COLUMN_TYPE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member> + . */ const long UNKNOWN = 0; //------------------------------------------------------------------------- @@ -82,8 +87,11 @@ constants ProcedureColumn /** indicates that the column stores IN parameters. A possible value for the column <code>COLUMN_TYPE</code> - in the <code>XResultSet</code> - returned by the method <code>getProcedureColumns</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member> + . */ const long IN = 1; //------------------------------------------------------------------------- @@ -92,8 +100,11 @@ constants ProcedureColumn /** indicates that the column stores INOUT parameters. A possible value for the column <code>COLUMN_TYPE</code> - in the <code>XResultSet</code> - returned by the method <code>getProcedureColumns</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member> + . */ const long INOUT = 2; //------------------------------------------------------------------------- @@ -102,8 +113,11 @@ constants ProcedureColumn /** indicates that the column stores results. A possible value for the column <code>COLUMN_TYPE</code> - in the <code>XResultSet</code> - returned by the method <code>getProcedureColumns</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member> + . */ const long RESULT = 3; //------------------------------------------------------------------------- @@ -112,8 +126,11 @@ constants ProcedureColumn /** indicates that the column stores OUT parameters. A possible value for the column <code>COLUMN_TYPE</code> - in the <code>XResultSet</code> - returned by the method <code>getProcedureColumns</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member> + . */ const long OUT = 4; //------------------------------------------------------------------------- @@ -122,8 +139,11 @@ constants ProcedureColumn /** Indicates that the column stores return values. A possible value for the column <code>COLUMN_TYPE</code> - in the <code>XResultSet</code> - returned by the method <code>getProcedureColumns</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member> + . */ const long RETURN = 5; }; @@ -134,6 +154,12 @@ constants ProcedureColumn /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/ProcedureResult.idl b/offapi/com/sun/star/sdbc/ProcedureResult.idl index c0dd0a45ef69..5ec9a3458295 100644 --- a/offapi/com/sun/star/sdbc/ProcedureResult.idl +++ b/offapi/com/sun/star/sdbc/ProcedureResult.idl @@ -2,9 +2,9 @@ * * $RCSfile: ProcedureResult.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,31 +71,49 @@ constants ProcedureResult { // DocMerge from idl: value com::sun::star::sdbc::ProcedureResult::UNKNOWN - /** A possible value for column <code>PROCEDURE_TYPE</code> in the - <code>XResultSet</code> object returned by the method - <code>getProcedures</code>. - <p> Indicates that it is not known whether the procedure returns + /** A possible value for column + <code>PROCEDURE_TYPE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedures()</member> + . + <p> + Indicates that it is not known whether the procedure returns a result. + </p> */ const long UNKNOWN = 0; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::ProcedureResult::NONE - /** A possible value for column <code>PROCEDURE_TYPE</code> in the - <code>XResultSet</code> object returned by the method - <code>getProcedures</code>. - <p> Indicates that the procedure does not return + /** A possible value for column + <code>PROCEDURE_TYPE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedures()</member> + . + <p> + Indicates that the procedure does not return a result. + </p> */ const long NONE = 1; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::ProcedureResult::RETURN - /** A possible value for column <code>PROCEDURE_TYPE</code> in the - <code>XResultSet</code> object returned by the method - <code>getProcedures</code>. - <p> Indicates that the procedure returns + /** A possible value for column + <code>PROCEDURE_TYPE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedures()</member> + . + <p> + Indicates that the procedure returns a result. + </p> */ const long RETURN = 2; }; @@ -106,6 +124,12 @@ constants ProcedureResult /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:40 hjs initial import diff --git a/offapi/com/sun/star/sdbc/ResultSet.idl b/offapi/com/sun/star/sdbc/ResultSet.idl index 9d8dcf81243a..121dfda71c15 100644 --- a/offapi/com/sun/star/sdbc/ResultSet.idl +++ b/offapi/com/sun/star/sdbc/ResultSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: ResultSet.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -92,22 +92,27 @@ interface XCloseable; - <p>A ResultSet maintains a cursor pointing to its current row of + <p> + A ResultSet maintains a cursor pointing to its current row of data. Initially the cursor is positioned before the first row. The 'next' method moves the cursor to the next row. </p> - <p>The getXXX methods retrieve column values for the current + <p> + The getXXX methods retrieve column values for the current row. You can retrieve values using either the index number of the column. Columns are numbered from 1. </p> - <p>For maximum portability, ResultSet columns within each row should be + <p> + For maximum portability, ResultSet columns within each row should be read in left-to-right order and each column should be read only once. </p> - <p>For the getXXX methods, the SDBC driver attempts to convert the + <p> + For the getXXX methods, the SDBC driver attempts to convert the underlying data to the specified type and returns a suitable value. </p> - <p>Column names used as input to the findColumn method are case + <p> + Column names used as input to the findColumn method are case insensitive. When several columns have the same name, then the value of the first matching column will be returned. The column name option is designed to be used when column names are used in the SQL @@ -116,13 +121,16 @@ interface XCloseable; no way for the programmer to guarantee that they actually refer to the intended columns. </p> - <p>A ResultSet is automatically closed (disposed) by the Statement that + <p> + A ResultSet is automatically closed (disposed) by the Statement that generated it when that Statement is closed, re-executed, or used to retrieve the next result from a sequence of multiple results. </p> - <p>The number, types, and properties of a ResultSet's columns are + <p> + The number, types, and properties of a ResultSet's columns are provided by the ResultSetMetaData object returned by the getMetaData - method.</p> + method. + </p> */ service ResultSet { @@ -137,14 +145,18 @@ service ResultSet // DocMerge from xml: service com::sun::star::sdbc::ResultSet: interface com::sun::star::sdbc::XCloseable /** freeing all resources of a result set. - <p>The creating statement will still be open after disposing. + <p> + The creating statement will still be open after disposing. + </p> - <p>This interface is mandatory only for JDBC conformance, + <p> + This interface is mandatory only for JDBC conformance, otherwise it is optional. + </p> */ [optional] interface XCloseable; - // DocMerge: empty anyway + // gives access to the properties. interface com::sun::star::beans::XPropertySet; @@ -152,11 +164,13 @@ service ResultSet /** controls the chaining of warnings, which may occur on every call to the connected database. - <p>Chained warnings from previous calls will be - cleared before processing a new call. + <p> + Chained warnings from previous calls will be cleared before processing a new call. + </p> - <p>This interface is mandatory only for JDBC conformance, - otherwise it is optional. + <p> + This interface is mandatory only for JDBC conformance, otherwise it is optional. + </p> */ [optional] interface XWarningsSupplier; @@ -176,7 +190,9 @@ service ResultSet // DocMerge from xml: service com::sun::star::sdbc::ResultSet: interface com::sun::star::sdbc::XResultSetUpdate /** is the interface for updating row data to the database. - <p>The implementation is optional. + <p> + The implementation is optional. + </p> */ [optional] interface XResultSetUpdate; @@ -196,17 +212,21 @@ service ResultSet // DocMerge from xml: service com::sun::star::sdbc::ResultSet: interface com::sun::star::sdbc::XRowUpdate /** is the interface for updating the data of the current row. - <p>The implementation is optional. + <p> + The implementation is optional. + </p> */ [optional] interface XRowUpdate; // DocMerge from xml: property com::sun::star::sdbc::ResultSet::CursorName /** defines the SQL cursor name that will be used by subsequent Statement - <code>execute</code> methods. + <code>execute</code> + methods. - <p>This name can then be used in SQL positioned update/delete statements to + <p> + This name can then be used in SQL positioned update/delete statements to identify the current row in the ResultSet generated by this statement. If the database doesn't support positioned update/delete, this property is a noop. To insure that a cursor has the proper isolation level to support @@ -215,10 +235,14 @@ service ResultSet positioned updates may fail. </p> <p> - <b>Note:</b> By definition, positioned update/delete + <b> + Note: + </b> + By definition, positioned update/delete execution must be done by a different Statement than the one which generated the ResultSet being used for positioning. Also, - cursor names must be unique within a connection.</p> + cursor names must be unique within a connection. + </p> @optional */ @@ -240,7 +264,9 @@ service ResultSet // DocMerge from xml: property com::sun::star::sdbc::ResultSet::FetchDirection /** retrieves the direction for fetching rows from database tables that is the default for result sets generated from this - <code>Statement</code> object.<br> + <type scope="sun::com::star::sdbc">Statement</type> + object. + <br/> If this <code>Statement</code> object has not set a fetch direction, the return value is implementation-specific. */ @@ -249,8 +275,13 @@ service ResultSet // DocMerge from xml: property com::sun::star::sdbc::ResultSet::FetchSize /** retrieves the number of result set rows that is the default fetch size - for result sets generated from this <code>Statement</code> object.<br> - If this <code>Statement</code> object has not set a fetch size, + for result sets generated from this + <type scope="sun::com::star::sdbc">Statement</type> + object. + <br/> + If this + <type scope="sun::com::star::sdbc">Statement</type> + object has not set a fetch size, the return value is implementation-specific. */ [property] long FetchSize; @@ -262,6 +293,15 @@ service ResultSet /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.2 2002/02/18 12:55:23 oj + #97563# parameter,return value and exception description + + Revision 1.5.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/01/23 10:08:29 mi optional interfaces now marked as [optional] instead of just a prosa description of this fact diff --git a/offapi/com/sun/star/sdbc/ResultSetConcurrency.idl b/offapi/com/sun/star/sdbc/ResultSetConcurrency.idl index 5a50ed9ffde6..1557e3c01231 100644 --- a/offapi/com/sun/star/sdbc/ResultSetConcurrency.idl +++ b/offapi/com/sun/star/sdbc/ResultSetConcurrency.idl @@ -2,9 +2,9 @@ * * $RCSfile: ResultSetConcurrency.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,14 +71,17 @@ constants ResultSetConcurrency { // DocMerge from idl: value com::sun::star::sdbc::ResultSetConcurrency::READ_ONLY - /** is the concurrency mode for a <code>ResultSet</code> object that may NOT be updated. + /** is the concurrency mode for a + <type scope="sun::com::star::sdbc">ResultSet</type> + object that may NOT be updated. */ const long READ_ONLY = 1007; // DocMerge from idl: value com::sun::star::sdbc::ResultSetConcurrency::UPDATABLE - /** is the concurrency mode for a <code>ResultSet</code> object - that may be updated. + /** is the concurrency mode for a + <type scope="sun::com::star::sdbc">ResultSet</type> + object that may be updated. */ const long UPDATABLE = 1008; }; @@ -89,6 +92,12 @@ constants ResultSetConcurrency /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:40 hjs initial import diff --git a/offapi/com/sun/star/sdbc/ResultSetType.idl b/offapi/com/sun/star/sdbc/ResultSetType.idl index 0368ae9b9894..76487a6fe03c 100644 --- a/offapi/com/sun/star/sdbc/ResultSetType.idl +++ b/offapi/com/sun/star/sdbc/ResultSetType.idl @@ -2,9 +2,9 @@ * * $RCSfile: ResultSetType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,21 +71,26 @@ constants ResultSetType { // DocMerge from idl: value com::sun::star::sdbc::ResultSetType::FORWARD_ONLY - /** is the type for a <code>ResultSet</code> object whose cursor may - move only forward. + /** is the type for a + <type scope="sun::com::star::sdbc">ResultSet</type> + object whose cursor may move only forward. */ const long FORWARD_ONLY = 1003; // DocMerge from idl: value com::sun::star::sdbc::ResultSetType::SCROLL_INSENSITIVE - /** is the type for a <code>ResultSet</code> object that is scrollable + /** is the type for a + <type scope="sun::com::star::sdbc">ResultSet</type> + object that is scrollable but generally not sensitive to changes made by others. */ const long SCROLL_INSENSITIVE = 1004; // DocMerge from idl: value com::sun::star::sdbc::ResultSetType::SCROLL_SENSITIVE - /** is the type for a <code>ResultSet</code> object that is scrollable + /** is the type for a + <type scope="sun::com::star::sdbc">ResultSet</type> + object that is scrollable and generally sensitive to changes made by others. */ const long SCROLL_SENSITIVE = 1005; @@ -97,6 +102,12 @@ constants ResultSetType /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:40 hjs initial import diff --git a/offapi/com/sun/star/sdbc/RowSet.idl b/offapi/com/sun/star/sdbc/RowSet.idl index 2ea716cf860b..ba29e1ecc1f1 100644 --- a/offapi/com/sun/star/sdbc/RowSet.idl +++ b/offapi/com/sun/star/sdbc/RowSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: RowSet.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,6 +64,9 @@ #ifndef __com_sun_star_sdbc_ResultSet_idl__ #include <com/sun/star/sdbc/ResultSet.idl> #endif +#ifndef __com_sun_star_sdbc_XColumnLocate_idl__ +#include <com/sun/star/sdbc/XColumnLocate.idl> +#endif module com { module sun { module star { module container { interface XNameAccess; @@ -76,33 +79,44 @@ interface XParameters; // DocMerge from xml: service com::sun::star::container::com::sun::star::sdbc::RowSet -/** is a client side ResultSet, which combines the characteristics of a Statement - and a ResultSet. +/** is a client side ResultSet, which combines the characteristics of a + <type scope="sun::com::star::sdbc">Statement</type> + and a + <type scope="sun::com::star::sdbc">ResultSet</type> + . - <p> It acts like a typical bean. Before you use the RowSet, you have to specify a + <p> + It acts like a typical bean. Before you use the RowSet, you have to specify a set of properties like a DataSource and a Command and other properties known of - Statement.<br> + Statement. + <br/> Afterwards, you can populate the RowSet by its execute method to fill the set with data. </p> - <p>On the one hand, a RowSet can be used as a short cut to retrieve the data of a DataSource. + <p> + On the one hand, a RowSet can be used as a short cut to retrieve the data of a DataSource. You don't have to establish a connection, create a Statement, and then create a ResultSet. On the other hand, a rowset can be used to implement capabilties for a result set, which are not supported by a driver result set, like caching - strategies or update capabilities.</p> + strategies or update capabilities. + </p> */ service RowSet { // DocMerge: empty anyway service com::sun::star::sdbc::ResultSet; - // DocMerge: empty anyway + // used to execute and to add/remove listeners. interface XRowSet; - // DocMerge: empty anyway + // used to set parameters. interface XParameters; + /** allows locating columns which's name is known only. + */ + interface XColumnLocate; + // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::DataSourceName /** is the name of a named datasource to use.@see com::sun::star::sdbc:XDataSource */ @@ -146,7 +160,9 @@ service RowSet // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::QueryTimeOut /** retrieves the number of seconds the driver will wait for a Statement - to execute. If the limit is exceeded, a SQLException is thrown. + to execute. If the limit is exceeded, a + <type scope="sun::com::star::sdbc">SQLException</type> + is thrown. There is no limitation, if set to zero. */ [property] long QueryTimeOut; @@ -155,12 +171,26 @@ service RowSet // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::MaxFieldSize /** returns the maximum number of bytes allowed for any column value. - - <p>This limit is the maximum number of bytes that can be returned - for any column value. The limit applies only to BINARY, - VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR columns. + <p> + This limit is the maximum number of bytes that can be returned + for any column value. The limit applies only to + <member scope= "com::sun::star::sdbc">DataType::BINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::VARBINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::LONGVARBINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::CHAR</member> + , + <member scope= "com::sun::star::sdbc">DataType::VARCHAR</member> + , + and + <member scope= "com::sun::star::sdbc">DataType::LONGVARCHAR</member> + columns. If the limit is exceeded, the excess data is silently discarded. - <br>There is no limitation, if set to zero.</p> + <br/> + There is no limitation, if set to zero. + </p> */ [property] long MaxFieldSize; @@ -168,7 +198,8 @@ service RowSet // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::MaxRows /** retrieves the maximum number of rows that a ResultSet can contain. If the limit is exceeded, the excess rows are silently dropped. - <br>There is no limitation, if set to zero. + <br/> + There is no limitation, if set to zero. */ [property] long MaxRows; @@ -197,6 +228,18 @@ service RowSet /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.3 2002/06/07 09:47:05 fs + added XColumnLocate + + Revision 1.5.2.2 2002/02/18 12:55:23 oj + #97563# parameter,return value and exception description + + Revision 1.5.2.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/02/20 13:30:07 fs #82875# removed XClearParameters - this interface is obsolete, the functionality is covered by XParameters diff --git a/offapi/com/sun/star/sdbc/SQLException.idl b/offapi/com/sun/star/sdbc/SQLException.idl index 33d23616dd99..5cfff101f616 100644 --- a/offapi/com/sun/star/sdbc/SQLException.idl +++ b/offapi/com/sun/star/sdbc/SQLException.idl @@ -2,9 +2,9 @@ * * $RCSfile: SQLException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,15 +71,20 @@ // DocMerge from xml: exception com::sun::star::sdbc::SQLException /** is an exception that provides information on a database access error. - - - <p>Each <type scope="com::sun::star::sdbc">SQLException</type> provides several kinds of information: + <p> + Each + <type scope="com::sun::star::sdbc">SQLException</type> + provides several kinds of information: </p> + <p> <ul> - <li> a string describing the error. This is used as the <type scope="com::sun::star::uno">Exception</type> + <li> + a string describing the error. This is used as the + <type scope="com::sun::star::uno">Exception</type> message. </li> </ul> + </p> */ exception SQLException: com::sun::star::uno::Exception { @@ -111,6 +116,12 @@ exception SQLException: com::sun::star::uno::Exception /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/Statement.idl b/offapi/com/sun/star/sdbc/Statement.idl index 53dd8e14e1f4..966b3726c512 100644 --- a/offapi/com/sun/star/sdbc/Statement.idl +++ b/offapi/com/sun/star/sdbc/Statement.idl @@ -2,9 +2,9 @@ * * $RCSfile: Statement.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: oj $ $Date: 2002-07-19 11:16:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,11 +87,13 @@ interface XGeneratedResultSet; /** is used for executing a static SQL statement and obtaining the results produced by it. - <p>Only one ResultSet per Statement can be open at any point in + <p> + Only one ResultSet per Statement can be open at any point in time. Therefore, if the reading of one ResultSet is interleaved with the reading of another, each must have been generated by different Statements. All statement <code>execute</code> methods implicitly - close a statement's current ResultSet if an open one exists.</p> + close a statement's current ResultSet if an open one exists. + </p> */ service Statement { @@ -109,7 +111,7 @@ service Statement */ interface XCloseable; - // DocMerge: empty anyway + // gives access to the properties. interface com::sun::star::beans::XPropertySet; // DocMerge from xml: service com::sun::star::sdbc::Statement: interface com::sun::star::util::XCancellable @@ -135,9 +137,12 @@ service Statement // DocMerge from xml: service com::sun::star::sdbc::Statement: interface com::sun::star::sdbc::XBatchExecution /** provides the ability of batch execution. This interface is optional for execution. - <p>A driver implementing batch execution must return <TRUE/> for - <member scope= "com::sun::star::sdbc"> - XDatabaseMetaData::supportsBatchUpdates()</member> + <p> + A driver implementing batch execution must return + <TRUE/> + for + <member scope= "com::sun::star::sdbc"> XDatabaseMetaData::supportsBatchUpdates()</member> + </p> */ [optional] interface XBatchExecution; @@ -168,12 +173,26 @@ service Statement // DocMerge from xml: property com::sun::star::sdbc::Statement::MaxFieldSize /** returns the maximum number of bytes allowed for any column value. - - <p>This limit is the maximum number of bytes that can be returned - for any column value. The limit applies only to BINARY, - VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR columns. + <p> + This limit is the maximum number of bytes that can be returned + for any column value. The limit applies only to + <member scope= "com::sun::star::sdbc">DataType::BINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::VARBINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::LONGVARBINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::CHAR</member> + , + <member scope= "com::sun::star::sdbc">DataType::VARCHAR</member> + , + and + <member scope= "com::sun::star::sdbc">DataType::LONGVARCHAR</member> + columns. If the limit is exceeded, the excess data is silently discarded. - <br>There is no limitation, if set to zero.</p> + <br/> + There is no limitation, if set to zero. + </p> */ [property] long MaxFieldSize; @@ -181,17 +200,19 @@ service Statement // DocMerge from xml: property com::sun::star::sdbc::Statement::MaxRows /** retrieves the maximum number of rows that a ResultSet can contain. If the limit is exceeded, the excess rows are silently dropped. - <br>There is no limitation, if set to zero. + <br/> + There is no limitation, if set to zero. */ [property] long MaxRows; // DocMerge from xml: property com::sun::star::sdbc::Statement::CursorName /** defines the SQL cursor name that will be used by subsequent Statement - <code>execute</code> methods. + <code>execute</code> + methods. - - <p>This name can then be used in SQL positioned update/delete statements to + <p> + This name can then be used in SQL positioned update/delete statements to identify the current row in the ResultSet generated by this statement. If the database does not support positioned update/delete, this property is a noop. To insure that a cursor has the proper isolation level to support @@ -200,10 +221,14 @@ service Statement positioned updates may fail. </p> <p> - <b>Note:</b> By definition, positioned update/delete + <b> + Note: + </b> + By definition, positioned update/delete execution must be done by a different Statement than the one which generated the ResultSet being used for positioning. Also, - cursor names must be unique within a connection.</p> + cursor names must be unique within a connection. + </p> */ [property] string CursorName; @@ -223,8 +248,12 @@ service Statement // DocMerge from xml: property com::sun::star::sdbc::Statement::FetchDirection /** retrieves the direction for fetching rows from database tables that is the default for result sets generated from this - <code>Statement</code> object.<br> - If this <code>Statement</code> object has not set a fetch direction, + <code>Statement</code> + object. + <br/> + If this + <code>Statement</code> + object has not set a fetch direction, the return value is implementation-specific. */ [property] long FetchDirection; @@ -232,8 +261,13 @@ service Statement // DocMerge from xml: property com::sun::star::sdbc::Statement::FetchSize /** retrieves the number of result set rows that is the default fetch size - for result sets generated from this <code>Statement</code> object.<br> - If this <code>Statement</code> object has not set a fetch size, + for result sets generated from this + <code>Statement</code> + object. + <br/> + If this + <code>Statement</code> + object has not set a fetch size, the return value is implementation-specific. */ [property] long FetchSize; @@ -251,43 +285,4 @@ service Statement }; }; }; }; -/*=========================================================================== - $Log: not supported by cvs2svn $ - Revision 1.7 2002/07/19 10:09:02 oj - #95146# new interface to query for autogenerated values - - Revision 1.6 2001/11/01 16:46:46 mi - proofreading and corrections from Richard Holt - - Revision 1.5 2001/01/23 10:08:29 mi - optional interfaces now marked as [optional] instead of just a prosa description of this fact - - Revision 1.4 2000/12/19 16:03:44 mi - documentations syntax errors fixed - - Revision 1.3 2000/11/08 12:43:35 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:41 hjs - initial import - - Revision 1.7 2000/09/11 11:52:42 mi - documentation merged from XML - - Revision 1.5 2000/01/27 08:08:01 dg - #72164# EscapeProcessing instead of UseEscapeProcessing - - Revision 1.4 1999/12/20 16:11:34 dg - #70278# changes in API - - Revision 1.3 1999/12/14 12:05:45 dg - #70278# CompareBookmark removed - - Revision 1.2 1999/11/30 20:21:19 dg - #70248# XMultipleResultSet optional - - Revision 1.1 1999/11/24 08:41:02 dg - new StarDataBaseConnectivity - -===========================================================================*/ #endif diff --git a/offapi/com/sun/star/sdbc/TransactionIsolation.idl b/offapi/com/sun/star/sdbc/TransactionIsolation.idl index e0323390e5f4..bf28a48918ba 100644 --- a/offapi/com/sun/star/sdbc/TransactionIsolation.idl +++ b/offapi/com/sun/star/sdbc/TransactionIsolation.idl @@ -2,9 +2,9 @@ * * $RCSfile: TransactionIsolation.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -105,7 +105,8 @@ constants TransactionIsolation // DocMerge from idl: value com::sun::star::sdbc::TransactionIsolation::SERIALIZABLE /** Dirty reads, non-repeatable reads and phantom reads are prevented. This level includes the prohibitions in - <code>REPEATABLE_READ</code> and further prohibits the + <code>REPEATABLE_READ</code> + and further prohibits the situation where one transaction reads all rows that satisfy a WHERE condition, a second transaction inserts a row that satisfies that WHERE condition, and the first transaction @@ -121,6 +122,12 @@ constants TransactionIsolation /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/XArray.idl b/offapi/com/sun/star/sdbc/XArray.idl index 40bb29f5a75d..914b03175927 100644 --- a/offapi/com/sun/star/sdbc/XArray.idl +++ b/offapi/com/sun/star/sdbc/XArray.idl @@ -2,9 +2,9 @@ * * $RCSfile: XArray.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,9 +79,16 @@ interface XResultSet; // DocMerge from xml: interface com::sun::star::container::com::sun::star::sdbc::XArray -/** is used for mapping the SQL type <code>ARRAY</code>. - By default, an <code>Array</code> is a transaction duration - reference to an SQL array. By default, an <code>Array</code> +/** is used for mapping the SQL type + <member scope= "com::sun::star::sdbc">DataType::ARRAY</member> + . + By default, an + <code>Array</code> + is a transaction duration + reference to an SQL array. By default, an + + <code>Array</code> + is implemented using a SQL LOCATOR(array) internally. */ interface XArray: com::sun::star::uno::XInterface @@ -89,15 +96,20 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XArray::getBaseTypeName /** returns the SQL type name of the elements in - the array designated by this <code>Array</code> object. - - - <p>If the elements are a built-in type, it returns + the array designated by this + <code>Array</code> + object. + <p> + If the elements are a built-in type, it returns the database-specific type name of the elements. If the elements are a user-defined type (UDT), this method returns the fully-qualified SQL type name. - </p> + @returns + a String that is the database-specific name for a built-in base type or the fully-qualified SQL type name for a base type that is a UDT + + @throws SQLException + if a database access error occurs. */ string getBaseTypeName() raises (SQLException); @@ -105,7 +117,13 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XArray::getBaseType /** returns the SDBC type of the elements in the array designated - by this <code>Array</code> object. + by this + <code>Array</code> + object. + @returns + a constant from the SDBC types that is the type code for the elements in the array designated by this Array object. + @throws SQLException + if a database access error occurs. */ long getBaseType() raises (SQLException); @@ -113,14 +131,23 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::container::com::sun::star::sdbc::XArray::getArray /** retrieves the contents of the SQL array designated by this - <code>Array</code> object, using the specified <code>typeMap</code> + <code>Array</code> + object, using the specified + <code>typeMap</code> for type map customizations. - <p>If the base type of the array does not match a user-defined type - in <code>typeMap</code>, the standard mapping is used instead. + <p> + If the base type of the array does not match a user-defined type + in + <code>typeMap</code> + , the standard mapping is used instead. @param typeMap is a map object that contains mappings of SQL type names to - services. If the <code>typeMap</code> is <NULL/>, the type-map + services. If the + <code>typeMap</code> + is + <NULL/> + , the type-map associated with the connection for customizations of the type-mappings is used. @@ -138,7 +165,10 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::container::com::sun::star::sdbc::XArray::getArrayAtIndex /** returns an array containing a slice of the SQL array, beginning with the - specified <code>index</code> and containing up to <code>count</code> + specified + <code>index</code> + and containing up to + <code>count</code> successive elements of the SQL array. @param index @@ -148,12 +178,20 @@ interface XArray: com::sun::star::uno::XInterface is the number of successive SQL array elements to retrieve. @param typeMap is a map object that contains mappings of SQL type names to - services. If the <code>typeMap</code> is <NULL/>, the type-map + services. If the + <code>typeMap</code> + is + <NULL/> + , the type-map associated with the connection for customizations of the type-mappings is used. @returns - an array containing up to <code>count</code> consecutive elements - of the SQL array, beginning with element <code>index</code>. + an array containing up to + <code>count</code> + consecutive elements + of the SQL array, beginning with element + <code>index</code> + . @throws SQLException if an error occurs while attempting to access the array. */ @@ -167,10 +205,18 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XArray::getResultSet /** returns a result set that contains the elements of the array - designated by this <code>Array</code> object and uses the given - <code>typeMap</code> to map the array elements. If the base + designated by this + <code>Array</code> + object and uses the given + <code>typeMap</code> + to map the array elements. If the base type of the array does not match a user-defined type in - <code>typeMap</code> or the <code>typeMap</code> is <NULL/>, + <code>typeMap</code> + or the + <code>typeMap</code> + is + <NULL/> + , the connection type mapping is used instead. @@ -182,6 +228,14 @@ interface XArray: com::sun::star::uno::XInterface The rows are in ascending order corresponding to the order of the indices. </p> + + @param typeMap + contains mapping of SQL user-defined types to classes in the UNO programming language + @returns + a ResultSet object containing one row for each of the elements in the array designated by this Array object, + with the rows in ascending order based on the indices. + @throws SQLException + if a database access error occurs. */ XResultSet getResultSet([in]com::sun::star::container::XNameAccess typeMap) raises (SQLException); @@ -190,11 +244,20 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XArray::getResultSetAtIndex /** returns a result set holding the elements of the subarray that - starts at index <code>index</code> and contains up to - <code>count</code> successive elements. This method uses the given - <code>typeMap</code> to map the array elements. If the base + starts at index + <code>index</code> + and contains up to + <code>count</code> + successive elements. This method uses the given + <code>typeMap</code> + to map the array elements. If the base type of the array does not match a user-defined type in - <code>typeMap</code> or the <code>typeMap</code> is <NULL/>, + <code>typeMap</code> + or the + <code>typeMap</code> + is + <NULL/> + , the connection type mapping is used instead. @@ -206,6 +269,17 @@ interface XArray: com::sun::star::uno::XInterface The rows are in ascending order corresponding to the order of the indices. </p> + @param index + the array index of the first element to retrieve; the first element is at index 1. + @param count + the number of successive SQL array elements to retrieve, + @param typeMap + the Map object that contains the mapping of SQL type names to classes in the UNO programming language. + @returns + a ResultSet object containing up to count consecutive elements of the SQL array + designated by this Array object, starting at index index. + @throws SQLException + if a database access error occurs. */ XResultSet getResultSetAtIndex([in]long index, [in]long count, @@ -219,6 +293,12 @@ interface XArray: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/19 13:46:04 mi syntax errors in documentation fixed diff --git a/offapi/com/sun/star/sdbc/XBatchExecution.idl b/offapi/com/sun/star/sdbc/XBatchExecution.idl index a0b5f317030b..3c1da816d60b 100644 --- a/offapi/com/sun/star/sdbc/XBatchExecution.idl +++ b/offapi/com/sun/star/sdbc/XBatchExecution.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBatchExecution.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:06:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,12 +83,19 @@ interface XBatchExecution: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XBatchExecution::addBatch /** adds a SQL command to the current batch of commmands for the statement object. + @param sql + the SQL statement which should be appended to the batch. + + @throws SQLException + if a database access error occurs. */ void addBatch([in]string sql ) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XBatchExecution::clearBatch /** makes the set of commands in the current batch empty. + @throws SQLException + if a database access error occurs. */ void clearBatch() raises (SQLException); //------------------------------------------------------------------------- @@ -111,6 +118,12 @@ interface XBatchExecution: 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 diff --git a/offapi/com/sun/star/sdbc/XBlob.idl b/offapi/com/sun/star/sdbc/XBlob.idl index 1f949ace6572..2ed9694a3e3b 100644 --- a/offapi/com/sun/star/sdbc/XBlob.idl +++ b/offapi/com/sun/star/sdbc/XBlob.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBlob.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:06:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,61 +77,135 @@ interface XInputStream; // DocMerge from xml: interface com::sun::star::io::com::sun::star::sdbc::XBlob -/** is the representation (mapping) of an SQL <i>BLOB</i>. - +/** is the representation (mapping) of an SQL + <i> + BLOB + </i> + . <p> - A SQL <i>BLOB</i> is a built-in type that stores a + A SQL + <i> + BLOB + </i> + is a built-in type that stores a Binary Large Object as a column value in a row of a database table. - The driver implements <i>BLOB</i> using a - SQL <code>locator(BLOB)</code>, which means that a <code>Blob</code> - object contains a logical pointer to the SQL <i>BLOB</i> data rather - than the data itself. - <br> - A <code>Blob</code> object is valid for the duration of the - transaction in which is was created. + The driver implements + <i> + BLOB + </i> + using a + SQL + <code>locator(BLOB)</code> + , which means that a + <code>Blob</code> + object contains a logical pointer to the SQL + <i> + BLOB + </i> + data rather than the data itself. + <br/> + A + <code>Blob</code> + object is valid for the duration of the transaction in which is was created. </p> - <p>Methods in the interfaces <type scope="com::sun::star::sdbc">XResultSet</type>, - and <type scope="com::sun::star::sdbc">XPreparedStatement</type>, such as - <code>getBlob</code> and <code>setBlob</code> allow a programmer to - access the SQL <i>BLOB</i>.<br> - The <code>Blob</code> interface provides methods for getting the - length of a SQL <i>BLOB</i> (Binary Large Object) value, - for materializing a <i>BLOB</i> value on the client and for - determining the position of a pattern of bytes within a - <i>BLOB</i> value.</p> + <p> + Methods in the interfaces + <type scope="com::sun::star::sdbc">XResultSet</type> + , + and + <type scope="com::sun::star::sdbc">XPreparedStatement</type> + , such as + <code>getBlob</code> + and + <code>setBlob</code> + allow a programmer to access the SQL + <i> + BLOB + </i> + . + <br/> + The + <code>Blob</code> + interface provides methods for getting the length of a SQL + <i> + BLOB + </i> + (Binary Large Object) value, for materializing a + <i> + BLOB + </i> + value on the client and for determining the position of a pattern of bytes within a + <i> + BLOB + </i> + value. + </p> */ interface XBlob: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::length - /** returns the number of bytes in the <i>BLOB</i> value - designated by this <code>Blob</code> object. + /** returns the number of bytes in the + <i> + BLOB + </i> + value + designated by this + <code>Blob</code> + object. + @returns + the length + @throws SQLException + if a database access error occurs. */ hyper length() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from idl: method com::sun::star::io::com::sun::star::sdbc::XBlob::getBytes - /** returns as an array of bytes part or all of the <i>BLOB</i> - value that this <code>Blob</code> object designates. The byte - array contains up to <code>length</code> consecutive bytes - starting at position <code>pos</code>. + /** returns as an array of bytes part or all of the + <i> + BLOB + </i> + value that this + <code>Blob</code> + object designates. The byte + array contains up to + <code>length</code> + consecutive bytes + starting at position + <code>pos</code>. @param pos is the ordinal position of the first byte in the - <i>BLOB</i> value to be extracted; the first byte is at + <i> + BLOB + </i> + value to be extracted; the first byte is at position 1. @param length is the number of consecutive bytes to be copied. @returns - a byte array containing up to <code>length</code> - consecutive bytes from the <i>BLOB</i> value designated - by this <code>Blob</code> object, starting with the - byte at position <code>pos</code>. + a byte array containing up to + <code>length</code> + consecutive bytes from the + <i> + BLOB + </i> + value designated + by this + <code>Blob</code> + object, starting with the byte at position + <code>pos</code> + . @throws SQLException - if there is an error accessing the <i>BLOB</i>. + if there is an error accessing the + <i> + BLOB + </i> + . */ sequence<byte> getBytes([in]hyper pos, [in]long length) raises (SQLException); @@ -139,8 +213,17 @@ interface XBlob: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::getBinaryStream - /** retrieves the <i>BLOB</i> designated by this - <code>Blob</code> instance as a stream. + /** retrieves the + <i> + BLOB + </i> + designated by this + <code>Blob</code> + instance as a stream. + @returns + the stream + @throws SQLException + if a database access error occurs. */ com::sun::star::io::XInputStream getBinaryStream() raises (SQLException); @@ -148,10 +231,25 @@ interface XBlob: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::position /** determines the byte position at which the specified byte - <code>pattern</code> begins within the <i>BLOB</i> - value that this <code>Blob</code> object represents. The - search for <code>pattern</code> begins at position - <code>start</code>. + <code>pattern</code> + begins within the + <i> + BLOB + </i> + value that this + <code>Blob</code> + object represents. The + search for + <code>pattern</code> + begins at position + <code>start</code> + . + @param pattern + the pattern to search + @returns + the position + @throws SQLException + if a database access error occurs. */ hyper position([in]sequence<byte> pattern, [in]hyper start) raises (SQLException); @@ -159,10 +257,26 @@ interface XBlob: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::positionOfBlob - /** determines the byte position in the <i>BLOB</i> value - designated by this <code>Blob</code> object at which - <code>pattern</code> begins. The search begins at position - <code>start</code>. + /** determines the byte position in the + <i> + BLOB + </i> + value + designated by this + <code>Blob</code> + object at which + <code>pattern</code> + begins. The search begins at position + <code>start</code> + . + @param pattern + the pattern to search + @param start + position to start + @returns + the position + @throws SQLException + if a database access error occurs. */ hyper positionOfBlob([in]XBlob pattern,[in] hyper start) raises (SQLException); @@ -174,6 +288,12 @@ interface XBlob: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 09:00:56 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 diff --git a/offapi/com/sun/star/sdbc/XClob.idl b/offapi/com/sun/star/sdbc/XClob.idl index 5035e1a2b786..1d0e5b4ca7e8 100644 --- a/offapi/com/sun/star/sdbc/XClob.idl +++ b/offapi/com/sun/star/sdbc/XClob.idl @@ -2,9 +2,9 @@ * * $RCSfile: XClob.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:06:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,28 +77,62 @@ interface XInputStream; // DocMerge from xml: interface com::sun::star::io::com::sun::star::sdbc::XClob -/** is the mapping for the SQL <code>CLOB</code> type. +/** is the mapping for the SQL + <code>CLOB</code> + type. - <p>A SQL <code>CLOB</code> is a built-in type + <p> + A SQL + <code>CLOB</code> + is a built-in type that stores a Character Large Object as a column value in a row of a database table. - The driver implements a <code>Clob</code> object using a SQL - <code>locator(CLOB)</code>, which means that a <code>Clob</code> object - contains a logical pointer to the SQL <code>CLOB</code> data rather than - the data itself. A <code>Clob</code> object is valid for the duration + The driver implements a + <code>Clob</code> + object using a SQL + <code>locator(CLOB)</code> + , which means that a + <code>Clob</code> + object + contains a logical pointer to the SQL + <code>CLOB</code> + data rather than + the data itself. A + <code>Clob</code> + object is valid for the duration of the transaction in which it was created. </p> - <p>The <code>Clob</code> interface provides methods for getting the - length of a SQL <code>CLOB</code> (Character Large Object) value, - for materializing a <code>CLOB</code> value on the client, and for - searching for a substring or <code>CLOB</code> object within a - <code>CLOB</code> value. + <p> + The + <code>Clob</code> + interface provides methods for getting the + length of a SQL + <code>CLOB</code> + (Character Large Object) value, + for materializing a + <code>CLOB</code> + value on the client, and for + searching for a substring or + <code>CLOB</code> + object within a + <code>CLOB</code> + value. </p> - <p>Methods in the interfaces <type scope="com::sun::star::sdbc">XResultSet</type>, - and <type scope="com::sun::star::sdbc">XPreparedStatement</type>, such as - <code>getClob</code> and <code>setClob</code> allow a programmer to - access the SQL <code>CLOB</code>.<br> + <p> + Methods in the interfaces + <type scope="com::sun::star::sdbc">XResultSet</type> + , + and + <type scope="com::sun::star::sdbc">XPreparedStatement</type> + , such as + <code>getClob</code> + and + <code>setClob</code> + allow a programmer to + access the SQL + <code>CLOB</code> + . </p> */ interface XClob: com::sun::star::uno::XInterface @@ -106,28 +140,57 @@ interface XClob: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XClob::length - /** returns the number of characters in the <code>CLOB</code> value - designated by this <code>Clob</code> object. + /** returns the number of characters in the + <code>CLOB</code> + value + designated by this + <code>Clob</code> + object. + @returns + the length of the CLOB object + @throws SQLException + if a database access error occurs. */ hyper length() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XClob::getSubString - /** returns a copy of the specified substring in the <code>CLOB</code> value - designated by this <code>Clob</code> object. + /** returns a copy of the specified substring in the + <code>Clob</code> + value + designated by this + <code>Clob</code> + object. - <p>The substring begins at position <code>pos</code> and has up - to <code>length</code> consecutive characters. + <p> + The substring begins at position <code>pos</code> and has up + to + <code>length</code> + consecutive characters. </p> + @param pos + the starting position + @param length + the length of the substring + @returns + the substring + @throws SQLException + if a database access error occurs. */ string getSubString([in]hyper pos, [in]long length) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XClob::getCharacterStream - /** gets the <code>Clob</code> contents as a stream. + /** gets the + <code>Clob</code> + contents as a stream. + @returns + the stream + @throws SQLException + if a database access error occurs. */ com::sun::star::io::XInputStream getCharacterStream() raises (SQLException); @@ -135,8 +198,20 @@ interface XClob: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XClob::position /** determines the character position at which the specified substring - <code>searchstr</code> appears in the <code>CLOB</code>. The search - begins at position <code>start</code>. + <code>searchstr</code> + appears in the + <code>Clob</code> + . The search begins at position + <code>start</code> + . + @param searchstr + the string to search + @param start + the starting position + @returns + the length of the CLOB object + @throws SQLException + if a database access error occurs. */ hyper position([in]string searchstr, [in]long start) raises (SQLException); @@ -144,10 +219,23 @@ interface XClob: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XClob::positionOfClob - /** determines the character position at which the specified - <code>Clob</code> object <code>searchstr</code> appears in this - <code>Clob</code> object. The search begins at position - <code>start</code>. + /** determines the position at which the specified + <code>Clob</code> + object + <code>pattern</code> + appears in this + <code>Clob</code> + object. The search begins at position + <code>start</code> + . + @param pattern + the CLOB to search + @param start + the starting position + @returns + the position of the CLOB inside + @throws SQLException + if a database access error occurs. */ hyper positionOfClob([in]XClob pattern, [in]hyper start) raises (SQLException); @@ -159,6 +247,12 @@ interface XClob: 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 diff --git a/offapi/com/sun/star/sdbc/XCloseable.idl b/offapi/com/sun/star/sdbc/XCloseable.idl index cd5d2f92caf0..9256a2d5ef86 100644 --- a/offapi/com/sun/star/sdbc/XCloseable.idl +++ b/offapi/com/sun/star/sdbc/XCloseable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCloseable.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,6 +80,8 @@ interface XCloseable: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XCloseable::close /** releases all resources connected to an object. + @throws SQLException + if a database access error occurs. */ void close() raises (SQLException); }; @@ -90,6 +92,12 @@ interface XCloseable: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XColumnLocate.idl b/offapi/com/sun/star/sdbc/XColumnLocate.idl index 751644a1715e..324e17240def 100644 --- a/offapi/com/sun/star/sdbc/XColumnLocate.idl +++ b/offapi/com/sun/star/sdbc/XColumnLocate.idl @@ -2,9 +2,9 @@ * * $RCSfile: XColumnLocate.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:06:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,19 +78,27 @@ interface XResultSetMetaData; /** provides the possibility to find columns by their name. - <p>When several columns have the same name, then the value + <p> + When several columns have the same name, then the value of the first matching column will be returned. The column name option is designed to be used when column names are used in the SQL query. For columns that are NOT explicitly named in the query, it is best to use column numbers. If column names are used, there is no way for the programmer to guarantee that they actually refer to - the intended columns.</p> + the intended columns. + </p> */ interface XColumnLocate: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::XColumnLocate::findColumn /** maps the given Resultset column name to its ResultSet column index. + @param columnName + the name of the column + @returns + the position of the column + @throws SQLException + if a database access error occurs. */ long findColumn([in]string columnName) raises (SQLException); }; @@ -101,6 +109,12 @@ interface XColumnLocate: 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 diff --git a/offapi/com/sun/star/sdbc/XConnection.idl b/offapi/com/sun/star/sdbc/XConnection.idl index ac5856dcc6ef..b821c0cab39c 100644 --- a/offapi/com/sun/star/sdbc/XConnection.idl +++ b/offapi/com/sun/star/sdbc/XConnection.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConnection.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,87 +90,133 @@ interface XDatabaseMetaData; executed and results are returned. - <p>A Connection's database is able to provide information + <p> + A Connection's database is able to provide information describing its tables, its supported SQL grammar, its stored procedures, and the capabilities of this connection. This - information is obtained with the <code>getMetaData</code> method. - - </p>@see com::sun::star::sdbc::XDriverManager - @see com::sun::star::sdbc::XStatement - @see com::sun::star::sdbc::XDatabaseMetaData + information is obtained with the + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getMetaData()</member> + method. + + </p> + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::XStatement + @see com::sun::star::sdbc::XDatabaseMetaData */ interface XConnection: com::sun::star::sdbc::XCloseable { // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::createStatement - /** creates a new <code>Statement</code> object for sending - SQL statements to the database. + /** creates a new + <type scope="com::sun::star::sdbc">Statement</type> + object for sending SQL statements to the database. - <p>SQL statements without parameters are normally + <p> + SQL statements without parameters are normally executed using Statement objects. If the same SQL statement is executed many times, it is more efficient to use a - PreparedStatement <type scope="com::sun::star::sdbc">PreparedStatement</type>. + <type scope="com::sun::star::sdbc">PreparedStatement</type> + . </p> - <p>Result sets created using the returned Statement will have + <p> + Result sets created using the returned Statement will have forward-only type, and read-only concurrency, by default. </p> - <p>Escape processing for the SQL-Statement is enabled, by default. + <p> + Escape processing for the SQL-Statement is enabled, by default. </p> + + @returns + a new Statement object + @throws SQLException + if a database access error occurs. */ XStatement createStatement() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::prepareStatement - /** creates a <code>PreparedStatement</code> object for sending - parameterized SQL statements to the database. + /** creates a + <type scope="com::sun::star::sdbc">PreparedStatement</type> + object for sending parameterized SQL statements to the database. - <p>A SQL statement with or without IN parameters can be + <p> + A SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times. </p> <p> - <b>Note:</b> This method is optimized for handling + <b> + Note: + </b> + This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, - the method <code>prepareStatement</code> will send + the method + <code>prepareStatement</code> + will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may - not be sent to the database until the <code>PreparedStatement</code> is - executed. This has no direct effect on users; however, it does + not be sent to the database until the + <type scope="com::sun::star::sdbc">PreparedStatement</type> + is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions. </p> - <p> Result sets created using the returned PreparedStatement will have + <p> + Result sets created using the returned PreparedStatement will have forward-only type and read-only concurrency, by default. </p> - <p>Escape processing for the SQL-Statement is enabled, by default. + <p> + Escape processing for the SQL-Statement is enabled, by default. </p> + + @param sql + a SQL statement that may contain one or more '?' IN parameter placeholders + @returns + a new PreparedStatement object containing the pre-compiled statement + @throws SQLException + if a database access error occurs. */ XPreparedStatement prepareStatement([in]string sql) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::prepareCall - /** creates a <code>CallableStatement</code> object for calling + /** creates a + <type scope="com::sun::star::sdbc">CallableStatement</type> + object for calling database stored procedures. - <p>The CallableStatement provides methods for setting up its IN and OUT + <p> + The CallableStatement provides methods for setting up its IN and OUT parameters, and methods for executing the call to a stored procedure. </p> <p> - <b>Note:</b> This method is optimized for handling stored + <b> + Note: + </b> + This method is optimized for handling stored procedure call statements. Some drivers may send the call - statement to the database when the method <code>prepareCall</code> - is done;<br> + statement to the database when the method + <code>prepareCall</code> + is done; + <br/> others may wait until the CallableStatement is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions. Result sets created using the returned CallableStatement will have forward-only type and read-only concurrency, by default. </p> + + @param sql + a SQL statement that may contain one or more '?' IN parameter placeholders + @returns + a new PreparedStatement object containing the pre-compiled statement + @throws SQLException + if a database access error occurs. */ XPreparedStatement prepareCall([in]string sql) raises (SQLException); //------------------------------------------------------------------------- @@ -180,6 +226,13 @@ interface XConnection: com::sun::star::sdbc::XCloseable A driver may convert the JDBC SQL grammar into its system's native SQL grammar prior to sending it; this method returns the native form of the statement that the driver would have sent. + + @param sql + a SQL statement that may contain one or more '?' parameter placeholders + @returns + the native form of this statement + @throws SQLException + if a database access error occurs. */ string nativeSQL([in]string sql) raises (SQLException); //------------------------------------------------------------------------- @@ -188,14 +241,20 @@ interface XConnection: com::sun::star::sdbc::XCloseable /** sets this connection's auto-commit mode. - <p>If a connection is in auto-commit mode, then all its SQL + <p> + If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by a call to either - the method <code>commit</code> or the method <code>rollback</code>. + the method + <member scope="com::sun::star::sdbc">XConnection::commit()</member> + or the method + <member scope="com::sun::star::sdbc">XConnection::rollback()</member> + . By default, new connections are in auto-commit mode. </p> - <p>The commit occurs when the statement completes or the next + <p> + The commit occurs when the statement completes or the next execute occurs, whichever comes first. In the case of statements returning a ResultSet, the statement completes when the last row of the ResultSet has been retrieved or the @@ -204,6 +263,11 @@ interface XConnection: com::sun::star::sdbc::XCloseable parameter values. In these cases the commit occurs when all results and output parameter values have been retrieved. </p> + + @param autoCommit + <TRUE/> enables auto-commit; <FALSE/> disables auto-commit. + @throws SQLException + if a database access error occurs. */ void setAutoCommit([in] boolean autoCommit) raises (SQLException); //------------------------------------------------------------------------- @@ -211,6 +275,11 @@ interface XConnection: com::sun::star::sdbc::XCloseable // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::getAutoCommit /** gets the current auto-commit state. + @returns + the current state of auto-commit mode. + @throws SQLException + if a database access error occurs. + @see setAutoCommit */ boolean getAutoCommit() raises (SQLException); @@ -222,6 +291,9 @@ interface XConnection: com::sun::star::sdbc::XCloseable by the Connection. This method should be used only when auto-commit mode has been disabled. + @throws SQLException + if a database access error occurs. + @see setAutoCommit */ void commit() raises (SQLException); @@ -232,6 +304,9 @@ interface XConnection: com::sun::star::sdbc::XCloseable commit/rollback and releases any database locks currently held by this Connection. This method should be used only when auto-commit has been disabled. + @throws SQLException + if a database access error occurs. + @see setAutoCommit */ void rollback() raises (SQLException); @@ -242,9 +317,17 @@ interface XConnection: com::sun::star::sdbc::XCloseable <p> - <b>Note:</b> A Connection is automatically closed if no one references it + <b> + Note: + </b> + A Connection is automatically closed if no one references it anymore. Certain fatal errors also result in a closed Connection. </p> + + @returns + <TRUE/> if the connection is closed; <FALSE/> if it's still open. + @throws SQLException + if a database access error occurs. */ boolean isClosed() raises (SQLException); //------------------------------------------------------------------------- @@ -253,12 +336,18 @@ interface XConnection: com::sun::star::sdbc::XCloseable /** gets the metadata regarding this connection's database. - <p>A Connection's database is able to provide information + <p> + A Connection's database is able to provide information describing its tables, its supported SQL grammar, its stored procedures, the capabilities of this connection, and so on. This information is made available through a DatabaseMetaData object. </p> + + @returns + a DatabaseMetaData object for this Connection. + @throws SQLException + if a database access error occurs. */ XDatabaseMetaData getMetaData() raises (SQLException); //------------------------------------------------------------------------- @@ -269,16 +358,30 @@ interface XConnection: com::sun::star::sdbc::XCloseable <p> - <b>Note:</b> This method cannot be called while in the - middle of a transaction. Calling setReadOnly with <TRUE/> does not + <b> + Note: + </b> + This method cannot be called while in the + middle of a transaction. Calling setReadOnly with + <TRUE/> + does not necessarily cause writes to be prohibited. </p> + + @param readONly + <TRUE/> enables read-only mode; <FALSE/> disables read-only mode. + @throws SQLException + if a database access error occurs. */ void setReadOnly([in]boolean readOnly) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::isReadOnly /** tests to see if the connection is in read-only mode. + @returns + <TRUE/> if connection is read-only and <FALSE/> otherwise. + @throws SQLException + if a database access error occurs. */ boolean isReadOnly() raises (SQLException); //------------------------------------------------------------------------- @@ -288,12 +391,20 @@ interface XConnection: com::sun::star::sdbc::XCloseable a subspace of this Connection's database in which to work. If the driver does not support catalogs, it will silently ignore this request. + @param catalog + the name of the catalog. + @throws SQLException + if a database access error occurs. */ void setCatalog([in]string catalog) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::getCatalog /** returns the Connection's current catalog name. + @returns + the current catalog name or an empty string. + @throws SQLException + if a database access error occurs. */ string getCatalog() raises (SQLException); //------------------------------------------------------------------------- @@ -302,21 +413,34 @@ interface XConnection: com::sun::star::sdbc::XCloseable /** attempts to change the transaction isolation level to the one given. - <p>The constants defined in - <type scope="com::sun::star::sdbc">TransactionIsolation</type> are the possible - transaction isolation levels. + <p> + The constants defined in + <type scope="com::sun::star::sdbc">TransactionIsolation</type> + are the possible transaction isolation levels. </p> <p> - <b>Note:</b> This method cannot be called while + <b> + Note: + </b> + This method cannot be called while in the middle of a transaction. - </p>@see - com::sun::star::sdbc::XDatabaseMetaData::supportsTransactionIsolationLevel() + </p> + @param level + one of the TransactionIsolation values with the exception of NONE; some databases may not support other values. + @throws SQLException + if a database access error occurs. + + @see com::sun::star::sdbc::XDatabaseMetaData::supportsTransactionIsolationLevel() */ void setTransactionIsolation([in]long level) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::getTransactionIsolation /** gets this Connection's current transaction isolation level. + @returns + the current TransactionIsolation mode value. + @throws SQLException + if a database access error occurs. */ long getTransactionIsolation() raises (SQLException); //------------------------------------------------------------------------- @@ -325,11 +449,16 @@ interface XConnection: com::sun::star::sdbc::XCloseable /** gets the type map object associated with this connection. Only drivers which implement the custom type mapping facility will return an object otherwise NULL could be returned. -<!-- JRH: changed "how implement" to "which implement" --> - <p>Unless the application has added an entry to the type map, the map + <p> + Unless the application has added an entry to the type map, the map returned will be empty. </p> + @returns + the XNameAccess object associated with this Connection object. + + @throws SQLException + if a database access error occurs. */ com::sun::star::container::XNameAccess getTypeMap() raises (SQLException); //------------------------------------------------------------------------- @@ -340,8 +469,14 @@ interface XConnection: com::sun::star::sdbc::XCloseable and distinct types. - <p>Only if the driver supports custom type mapping is the setting of a map allowed. + <p> + Only if the driver supports custom type mapping is the setting of a map allowed. </p> + + @param typeMap + set the XNameAccess object associated with this Connection object. + @throws SQLException + if a database access error occurs. */ void setTypeMap([in]com::sun::star::container::XNameAccess typeMap) raises (SQLException); @@ -353,6 +488,12 @@ interface XConnection: com::sun::star::sdbc::XCloseable /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.7.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.7 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.6 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XDataSource.idl b/offapi/com/sun/star/sdbc/XDataSource.idl index b21d07425c95..ba2e0466ac95 100644 --- a/offapi/com/sun/star/sdbc/XDataSource.idl +++ b/offapi/com/sun/star/sdbc/XDataSource.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataSource.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,6 +85,14 @@ interface XDataSource: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDataSource::getConnection /** attempts to establish a database connection. + @param user + the user name + @param password + the password + @returns + the connection object + @throws SQLException + if a database access error occurs. */ XConnection getConnection([in]string user, [in]string password) raises (SQLException); @@ -95,10 +103,15 @@ interface XDataSource: com::sun::star::uno::XInterface while attempting to connect to a database. - <p>A value of zero specifies that the timeout is the default system + <p> + A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. When a DataSource object is created the login timeout is initially zero. </p> + @param seconds + the login time limit in seconds + @throws SQLException + if a database access error occurs. */ void setLoginTimeout([in]long seconds) raises (SQLException); @@ -109,10 +122,15 @@ interface XDataSource: com::sun::star::uno::XInterface while attempting to connect to a database. - <p> A value of zero means that the timeout is the default system timeout + <p> + A value of zero means that the timeout is the default system timeout if there is one; otherwise, it means that there is no timeout. When a DataSource object is created the login timeout is initially zero. </p> + @returns + the login time limit in seconds + @throws SQLException + if a database access error occurs. */ long getLoginTimeout() raises (SQLException); }; @@ -123,6 +141,12 @@ interface XDataSource: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl b/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl index cd8f7687983e..cdfac633cbd2 100644 --- a/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl +++ b/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDatabaseMetaData.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: jsc $ $Date: 2001-11-28 15:32:14 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,19 +80,30 @@ interface XConnection; <p>Many of the methods here return lists of information in - the form of <code>XResultSet</code> objects. - You can use the normal XResultSet methods such as getString and getInt + the form of + <type scope="com::sun::star::sdbc">XResultSet</type> + objects. + You can use the normal <type scope="com::sun::star::sdbc">XResultSet</type> + methods such as + <member scope="com::sun::star::sdbc">XResultSet::getString()</member> + and + <member scope="com::sun::star::sdbc">XResultSet::getInt()</member> to retrieve the data from these XResultSets. If a given form of - metadata is not available, these methods should throw a SQLException. + metadata is not available, these methods should throw a + <type scope="com::sun::star::sdbc">SQLException</type> + . </p> - <p>Some of these methods take arguments that are String patterns. These - arguments all have names such as fooPattern. Within a pattern String, "%" + <p>Some of these methods take arguments that are String patterns. These + arguments all have names such as fooPattern. Within a pattern String, "%" means match any substring of 0 or more characters, and "_" means match any one character. Only metadata entries matching the search pattern - are returned. If a search pattern argument is set to a null ref, + are returned. If a search pattern argument is set to a <NULL/> ref, that argument's criteria will be dropped from the search. </p> - <p>A <code>SQLException</code> will be thrown if a driver does not support + <p> + A + <type scope="com::sun::star::sdbc">SQLException</type> + will be thrown if a driver does not support a meta data method. In the case of methods that return an XResultSet, either an XResultSet (which may be empty) is returned or a SQLException is thrown.</p> @@ -104,7 +115,14 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can all the procedures returned by getProcedures be called by the current user? -<!-- JRH:/MI: These questions are unclear, see "@return\<TRUE/>..." examples in this document for a better solution. --> + @return + <TRUE/> + if the user is allowed to call all procedures returned by getProcedures + otherwise + <FALSE/> + . + @throws SQLException + if a database access error occurs. */ boolean allProceduresAreCallable() raises (SQLException); //------------------------------------------------------------------------- @@ -112,6 +130,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::allTablesAreSelectable /** Can all the tables returned by getTable be SELECTed by the current user? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean allTablesAreSelectable() raises (SQLException); //------------------------------------------------------------------------- @@ -130,30 +152,50 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::isReadOnly /** checks if the database in read-only mode. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isReadOnly() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullsAreSortedHigh /** Are NULL values sorted high? -<!-- JRH: meaning sorted to start of file? -->*/ + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. + */ boolean nullsAreSortedHigh() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullsAreSortedLow /** Are NULL values sorted low? -<!-- JRH: meaning to end of file? -->*/ + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. + */ boolean nullsAreSortedLow() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullsAreSortedAtStart /** Are NULL values sorted at the start regardless of sort order? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean nullsAreSortedAtStart() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullsAreSortedAtEnd /** Are NULL values sorted at the end, regardless of sort order? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean nullsAreSortedAtEnd() raises (SQLException); //------------------------------------------------------------------------- @@ -196,18 +238,30 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::usesLocalFiles /** use the database local files to save the tables. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean usesLocalFiles() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::usesLocalFilePerTable /** use the database one local file to save for each table. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean usesLocalFilePerTable() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMixedCaseIdentifiers /** use the database 'mixed case unquoted SQL identifiers' case sensitive. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsMixedCaseIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -215,6 +269,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesUpperCaseIdentifiers /** Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upper case? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean storesUpperCaseIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -222,6 +280,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesLowerCaseIdentifiers /** Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in lower case? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean storesLowerCaseIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -229,6 +291,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesMixedCaseIdentifiers /** Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mixed case? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean storesMixedCaseIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -236,6 +302,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMixedCaseQuotedIdentifiers /** Does the database treat mixed case quoted SQL identifiers as case sensitive and as a result store them in mixed case? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsMixedCaseQuotedIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -243,6 +313,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesUpperCaseQuotedIdentifiers /** Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper case? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean storesUpperCaseQuotedIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -250,6 +324,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesLowerCaseQuotedIdentifiers /** Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower case? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean storesLowerCaseQuotedIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -257,6 +335,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesMixedCaseQuotedIdentifiers /** Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed case? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean storesMixedCaseQuotedIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -264,6 +346,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getIdentifierQuoteString /** What's the string used to quote SQL identifiers? This returns a space " " if identifier quoting is not supported. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getIdentifierQuoteString() raises (SQLException); //------------------------------------------------------------------------- @@ -271,36 +357,56 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getSQLKeywords /** gets a comma-separated list of all a database's SQL keywords that are NOT also SQL92 keywords. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getSQLKeywords() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getNumericFunctions - /** gets a comma-separated list of math functions. These are the + /** gets a comma-separated list of math functions. These are the X/Open CLI math function names used in the SDBC function escape clause. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getNumericFunctions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getStringFunctions - /** gets a comma-separated list of string functions. These are the + /** gets a comma-separated list of string functions. These are the X/Open CLI string function names used in the SDBC function escape clause. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getStringFunctions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getSystemFunctions - /** gets a comma-separated list of system functions. These are the + /** gets a comma-separated list of system functions. These are the X/Open CLI system function names used in the SDBC function escape clause. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getSystemFunctions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getTimeDateFunctions /** gets a comma-separated list of time and date functions. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getTimeDateFunctions() raises (SQLException); //------------------------------------------------------------------------- @@ -311,11 +417,17 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface the string pattern style catalog search parameters. - <p>The '_' character represents any single character. + <p> + The '_' character represents any single character. </p> - <p>The '%' character represents any sequence of zero or + <p> + The '%' character represents any sequence of zero or more characters. </p> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getSearchStringEscape() raises (SQLException); //------------------------------------------------------------------------- @@ -323,18 +435,30 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getExtraNameCharacters /** gets all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _). + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getExtraNameCharacters() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsAlterTableWithAddColumn /** support the Database "ALTER TABLE" with add column? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsAlterTableWithAddColumn() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsAlterTableWithDropColumn /** support the Database "ALTER TABLE" with drop column? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsAlterTableWithDropColumn() raises (SQLException); //------------------------------------------------------------------------- @@ -343,31 +467,52 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** support the Database column aliasing? - <p>The SQL AS clause can be used to provide names for + <p> + The SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required. </p> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsColumnAliasing() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullPlusNonNullIsNull /** are concatenations between NULL and non-NULL values NULL? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean nullPlusNonNullIsNull() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsTypeConversion - /** @returns - <TRUE/>, if the Database supports the CONVERT function between SQL types, - otherwise <FALSE/>. + /** <TRUE/> + , if the Database supports the CONVERT function between SQL types, + otherwise + <FALSE/> + . + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsTypeConversion() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsConvert - /** @returns - <TRUE/>, if the Database supports the CONVERT between the given SQL types - otherwise <FALSE/>. + /** <TRUE/> + , if the Database supports the CONVERT between the given SQL types + otherwise + <FALSE/> + . + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsConvert([in]long fromType, [in]long toType) raises (SQLException); @@ -375,6 +520,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsTableCorrelationNames /** Are table correlation names supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsTableCorrelationNames() raises (SQLException); //------------------------------------------------------------------------- @@ -382,6 +531,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsDifferentTableCorrelationNames /** If table correlation names are supported, are they restricted to be different from the names of the tables? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsDifferentTableCorrelationNames() raises (SQLException); @@ -389,24 +542,40 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsExpressionsInOrderBy /** Are expressions in "ORDER BY" lists supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsExpressionsInOrderBy() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOrderByUnrelated /** Can an "ORDER BY" clause use columns not in the SELECT statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsOrderByUnrelated() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsGroupBy /** Is some form of "GROUP BY" clause supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsGroupBy() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsGroupByUnrelated /** Can a "GROUP BY" clause use columns not in the SELECT? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsGroupByUnrelated() raises (SQLException); //------------------------------------------------------------------------- @@ -414,18 +583,30 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsGroupByBeyondSelect /** Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsGroupByBeyondSelect() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsLikeEscapeClause /** Is the escape character in "LIKE" clauses supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsLikeEscapeClause() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMultipleResultSets /** Are multiple XResultSets from a single execute supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsMultipleResultSets() raises (SQLException); //------------------------------------------------------------------------- @@ -433,36 +614,54 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMultipleTransactions /** Can we have multiple transactions open at once (on different connections)? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsMultipleTransactions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsNonNullableColumns /** Can columns be defined as non-nullable? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsNonNullableColumns() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMinimumSQLGrammar - /** @returns - <TRUE/>, if the database supports ODBC Minimum SQL grammar, + /** <TRUE/>, if the database supports ODBC Minimum SQL grammar, otherwise <FALSE/>. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsMinimumSQLGrammar() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCoreSQLGrammar - /** @returns - <TRUE/>, if the database supports ODBC Core SQL grammar, + /** <TRUE/>, if the database supports ODBC Core SQL grammar, otherwise <FALSE/>. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCoreSQLGrammar() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsExtendedSQLGrammar - /** @returns + /** <TRUE/>, if the database supports ODBC Extended SQL grammar, otherwise <FALSE/>. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsExtendedSQLGrammar() raises (SQLException); //------------------------------------------------------------------------- @@ -471,6 +670,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** @returns <TRUE/>, if the database supports ANSI92 entry level SQL grammar, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsANSI92EntryLevelSQL() raises (SQLException); //------------------------------------------------------------------------- @@ -479,6 +680,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** @returns <TRUE/>, if the database supports ANSI92 intermediate SQL grammar, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsANSI92IntermediateSQL() raises (SQLException); //------------------------------------------------------------------------- @@ -487,6 +690,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** @returns <TRUE/>, if the database supports ANSI92 full SQL grammar, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsANSI92FullSQL() raises (SQLException); //------------------------------------------------------------------------- @@ -495,6 +700,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** returns <TRUE/>, if the Database supports SQL Integrity Enhancement Facility, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsIntegrityEnhancementFacility() raises (SQLException); //------------------------------------------------------------------------- @@ -503,6 +710,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** @returns <TRUE/>, if some form of outer join is supported, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsOuterJoins() raises (SQLException); //------------------------------------------------------------------------- @@ -511,6 +720,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** @returns <TRUE/>, if full nested outer joins are supported, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsFullOuterJoins() raises (SQLException); //------------------------------------------------------------------------- @@ -518,26 +729,40 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsLimitedOuterJoins /** @returns <TRUE/>, if there is limited support for outer joins. - (This will be true if supportFullOuterJoins is true.) + (This will be <TRUE/> if supportFullOuterJoins is <TRUE/>.) <FALSE/> is returned otherwise. + @throws SQLException + if a database access error occurs. */ boolean supportsLimitedOuterJoins() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getSchemaTerm /** return the database vendor's preferred term for "schema" + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getSchemaTerm() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getProcedureTerm /** return the database vendor's preferred term for "procedure" + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getProcedureTerm() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getCatalogTerm /** return the database vendor's preferred term for "catalog" + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getCatalogTerm() raises (SQLException); //------------------------------------------------------------------------- @@ -545,42 +770,70 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::isCatalogAtStart /** Does a catalog appear at the start of a qualified table name? (Otherwise it appears at the end) + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isCatalogAtStart() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getCatalogSeparator /** return the separator between catalog and table name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getCatalogSeparator() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInDataManipulation /** Can a schema name be used in a data manipulation statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSchemasInDataManipulation() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInProcedureCalls /** Can a schema name be used in a procedure call statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSchemasInProcedureCalls() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInTableDefinitions /** Can a schema name be used in a table definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSchemasInTableDefinitions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInIndexDefinitions /** Can a schema name be used in an index definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSchemasInIndexDefinitions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInPrivilegeDefinitions /** Can a schema name be used in a privilege definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSchemasInPrivilegeDefinitions() raises (SQLException); @@ -588,30 +841,50 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInDataManipulation /** Can a catalog name be used in a data manipulation statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCatalogsInDataManipulation() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInProcedureCalls /** Can a catalog name be used in a procedure call statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCatalogsInProcedureCalls() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInTableDefinitions /** Can a catalog name be used in a table definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCatalogsInTableDefinitions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInIndexDefinitions /** Can a catalog name be used in an index definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCatalogsInIndexDefinitions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInPrivilegeDefinitions /** Can a catalog name be used in a privilege definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCatalogsInPrivilegeDefinitions() raises (SQLException); @@ -619,18 +892,30 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsPositionedDelete /** Is positioned DELETE supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsPositionedDelete() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsPositionedUpdate /** Is positioned UPDATE supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsPositionedUpdate() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSelectForUpdate /** Is SELECT for UPDATE supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSelectForUpdate() raises (SQLException); //------------------------------------------------------------------------- @@ -638,72 +923,120 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsStoredProcedures /** Are stored procedure calls using the stored procedure escape syntax supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsStoredProcedures() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSubqueriesInComparisons /** Are subqueries in comparison expressions supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSubqueriesInComparisons() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSubqueriesInExists /** Are subqueries in 'exists' expressions supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSubqueriesInExists() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSubqueriesInIns /** Are subqueries in 'in' statements supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSubqueriesInIns() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSubqueriesInQuantifieds /** Are subqueries in quantified expressions supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSubqueriesInQuantifieds() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCorrelatedSubqueries /** Are correlated subqueries supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCorrelatedSubqueries() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsUnion /** Is SQL UNION supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsUnion() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsUnionAll /** Is SQL UNION ALL supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsUnionAll() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOpenCursorsAcrossCommit /** Can cursors remain open across commits? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsOpenCursorsAcrossCommit() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOpenCursorsAcrossRollback /** Can cursors remain open across rollbacks? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsOpenCursorsAcrossRollback() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOpenStatementsAcrossCommit /** Can statements remain open across commits? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsOpenStatementsAcrossCommit() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOpenStatementsAcrossRollback /** Can statements remain open across rollbacks? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsOpenStatementsAcrossRollback() raises (SQLException); @@ -711,90 +1044,150 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxBinaryLiteralLength /** return the maximal number of hex characters in an inline binary literal + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxBinaryLiteralLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxCharLiteralLength /** return the max length for a character literal + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxCharLiteralLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnNameLength /** return the limit on column name length + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInGroupBy /** return the maximum number of columns in a "GROUP BY" clause + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnsInGroupBy() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInIndex /** return the maximum number of columns allowed in an index + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnsInIndex() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInOrderBy /** return the maximum number of columns in an "ORDER BY" clause + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnsInOrderBy() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInSelect /** return the maximum number of columns in a "SELECT" list + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnsInSelect() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInTable /** return the maximum number of columns in a table + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnsInTable() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxConnections /** return the number of active connections at a time to this database. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxConnections() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxCursorNameLength /** return the maximum cursor name length + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxCursorNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxIndexLength /** return the maximum length of an index (in bytes) + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxIndexLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxSchemaNameLength /** return the maximum length allowed for a schema name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxSchemaNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxProcedureNameLength /** return the maximum length of a procedure name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxProcedureNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxCatalogNameLength /** return the maximum length of a catalog name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxCatalogNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxRowSize /** return the maximum length of a single row. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxRowSize() raises (SQLException); //------------------------------------------------------------------------- @@ -802,57 +1195,97 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::doesMaxRowSizeIncludeBlobs /** Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean doesMaxRowSizeIncludeBlobs() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxStatementLength /** return the maximum length of a SQL statement + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxStatementLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxStatements /** return the maximal number of open active statements at one time to this database + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxStatements() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxTableNameLength /** return the maximum length of a table name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxTableNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxTablesInSelect /** return the maximum number of tables in a SELECT statement + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxTablesInSelect() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxUserNameLength /** return the maximum length of a user name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxUserNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getDefaultTransactionIsolation /** return the database default transaction isolation level. - The values are defined in <type scope="com::sun::star::sdbc">TransactionIsolation</type>.@see com::sun::star::sdbc::XConnection + The values are defined in + <type scope="com::sun::star::sdbc">TransactionIsolation</type>. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. + @see com::sun::star::sdbc::XConnection */ long getDefaultTransactionIsolation() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsTransactions /** support the Database transactions? - If not, invoking the method <code>commit</code> is a noop and the + If not, invoking the method + <member scope="com::Sun::star::sdbc">XConnection::commit()</member> + is a noop and the isolation level is TransactionIsolation_NONE. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsTransactions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsTransactionIsolationLevel /** Does this database support the given transaction isolation level? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. @see com::sun::star::sdbc::Connection */ boolean supportsTransactionIsolationLevel([in]long level) @@ -862,6 +1295,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsDataDefinitionAndDataManipulationTransactions /** support the Database both data definition and data manipulation statements within a transaction? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. <!-- JRH: Unclear on the intent of these many support questions. If asking, it should state, "Does the Database support both ....? If declaring, it should state something like the following: @@ -877,6 +1314,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsDataManipulationTransactionsOnly /** are only data manipulation statements within a transaction supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsDataManipulationTransactionsOnly() raises (SQLException); @@ -885,6 +1326,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::dataDefinitionCausesTransactionCommit /** does a data definition statement within a transaction force the transaction to commit? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean dataDefinitionCausesTransactionCommit() raises (SQLException); @@ -892,6 +1337,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::dataDefinitionIgnoredInTransactions /** is a data definition statement within a transaction ignored? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean dataDefinitionIgnoredInTransactions() raises (SQLException); @@ -902,18 +1351,20 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface catalog. - <p>Only procedure descriptions matching the schema and - procedure name criteria are returned. They are ordered by + <p> + Only procedure descriptions matching the schema and + procedure name criteria are returned. They are ordered by PROCEDURE_SCHEM, and PROCEDURE_NAME. </p> - <p>Each procedure description has the the following columns: + <p> + Each procedure description has the the following columns: </p> <ol> <li> - <b>PROCEDURE_CAT</b> string =&gt; procedure catalog (may be null) + <b>PROCEDURE_CAT</b> string =&gt; procedure catalog (may be <NULL/>) </li> <li> - <b>PROCEDURE_SCHEM</b> string =&gt; procedure schema (may be null) + <b>PROCEDURE_SCHEM</b> string =&gt; procedure schema (may be <NULL/>) </li> <li> <b>PROCEDURE_NAME</b> string =&gt; procedure name @@ -939,6 +1390,16 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param procedureNamePattern + a procedure name pattern + @returns + each row is a procedure description + @throws SQLException + if a database access error occurs. */ XResultSet getProcedures([in]any catalog, [in]string schemaPattern, [in]string procedureNamePattern) raises (SQLException); @@ -949,8 +1410,9 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface and result columns. - <p>Only descriptions matching the schema, procedure and - parameter name criteria are returned. They are ordered by + <p> + Only descriptions matching the schema, procedure and + parameter name criteria are returned. They are ordered by PROCEDURE_SCHEM and PROCEDURE_NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order. @@ -960,10 +1422,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>PROCEDURE_CAT</b> string =&gt; procedure catalog (may be null) + <b>PROCEDURE_CAT</b> string =&gt; procedure catalog (may be <NULL/>) </li> <li> - <b>PROCEDURE_SCHEM</b> string =&gt; procedure schema (may be null) + <b>PROCEDURE_SCHEM</b> string =&gt; procedure schema (may be <NULL/>) </li> <li> <b>PROCEDURE_NAME</b> string =&gt; procedure name @@ -1027,6 +1489,18 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface descriptions for a procedure. Additional columns beyond REMARKS can be defined by the database. </p> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param procedureNamePattern + a procedure name pattern + @param columnNamePattern + a column name pattern + @returns + each row describes a stored procedure parameter or column + @throws SQLException + if a database access error occurs. */ XResultSet getProcedureColumns([in]any catalog, [in]string schemaPattern, [in]string procedureNamePattern, @@ -1039,23 +1513,23 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <p>Only table descriptions matching the catalog, schema, table - name, and type criteria are returned. They are ordered by + name, and type criteria are returned. They are ordered by TABLE_TYPE, TABLE_SCHEM, and TABLE_NAME. </p> <p>Each table description has the following columns: </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name </li> <li> - <b>TABLE_TYPE</b> string =&gt; table type. Typical types are "TABLE", + <b>TABLE_TYPE</b> string =&gt; table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM". </li> @@ -1067,6 +1541,18 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>Note:</b> Some databases may not return information for all tables. </p> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param tableNamePattern + a table name pattern + @param types + a list of table types to include; <NULL/> returns all types + @returns + each row is a table description + @throws SQLException + if a database access error occurs. */ XResultSet getTables([in]any catalog, [in]string schemaPattern, [in]string tableNamePattern, [in]sequence<string> types) @@ -1085,6 +1571,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>TABLE_SCHEM</b> string =&gt; schema name </li> </ol> + @returns + each row has a single String column that is a schema name + @throws SQLException + if a database access error occurs. */ XResultSet getSchemas() raises (SQLException); //------------------------------------------------------------------------- @@ -1101,12 +1591,16 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>TABLE_CAT</b> string =&gt; catalog name </li> </ol> + @returns + each row has a single String column that is a catalog name + @throws SQLException + if a database access error occurs. */ XResultSet getCatalogs() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getTableTypes - /** gets the table types available in this database. The results + /** gets the table types available in this database. The results are ordered by table type. @@ -1114,11 +1608,15 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>TABLE_TYPE</b> string =&gt; table type. Typical types are "TABLE", + <b>TABLE_TYPE</b> string =&gt; table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM". </li> </ol> + @returns + each row has a single String column that is a table type + @throws SQLException + if a database access error occurs. */ XResultSet getTableTypes() raises (SQLException); //------------------------------------------------------------------------- @@ -1129,17 +1627,17 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <p>Only column descriptions matching the catalog, schema, table - and column name criteria are returned. They are ordered by + and column name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME, and ORDINAL_POSITION. </p> <p>Each column description has the following columns: </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name @@ -1155,7 +1653,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface for a UDT the type name is fully qualified </li> <li> - <b>COLUMN_SIZE</b> long =&gt; column size. For char or date + <b>COLUMN_SIZE</b> long =&gt; column size. For char or date types this is the maximum number of characters, for numeric or decimal types this is precision. </li> @@ -1180,10 +1678,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> <li> - <b>REMARKS</b> string =&gt; comment describing column (may be null) + <b>REMARKS</b> string =&gt; comment describing column (may be <NULL/>) </li> <li> - <b>COLUMN_DEF</b> string =&gt; default value (may be null) + <b>COLUMN_DEF</b> string =&gt; default value (may be <NULL/>) </li> <li> <b>SQL_DATA_TYPE</b> long =&gt; unused @@ -1202,9 +1700,21 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <li> <b>IS_NULLABLE</b> string =&gt; "NO" means column definitely does not allow NULL values; "YES" means the column might - allow NULL values. An empty string means nobody knows. + allow NULL values. An empty string means nobody knows. </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param tableNamePattern + a table name pattern + @param columnNamePattern + a column name pattern + @returns + each row is a column description + @throws SQLException + if a database access error occurs. */ XResultSet getColumns([in]any catalog, [in]string schemaPattern, [in]string tableNamePattern, [in]string columnNamePattern) @@ -1215,17 +1725,18 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** gets a description of the access rights for a table's columns. - <p>Only privileges matching the column name criteria are - returned. They are ordered by COLUMN_NAME and PRIVILEGE. + <p> + Only privileges matching the column name criteria are + returned. They are ordered by COLUMN_NAME and PRIVILEGE. </p> <p>Each privilige description has the following columns: </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name @@ -1234,7 +1745,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>COLUMN_NAME</b> string =&gt; column name </li> <li> - <b>GRANTOR</b> =&gt; grantor of access (may be null) + <b>GRANTOR</b> =&gt; grantor of access (may be <NULL/>) </li> <li> <b>GRANTEE</b> string =&gt; grantee of access @@ -1245,9 +1756,21 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>IS_GRANTABLE</b> string =&gt; "YES" if grantee is permitted - to grant to others; "NO" if not; null if unknown + to grant to others; "NO" if not; <NULL/> if unknown </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name ; "" retrieves those without a schema + @param table + a table name + @param columnNamePattern + a column name pattern + @returns + each row is a column privilege description + @throws SQLException + if a database access error occurs. */ XResultSet getColumnPrivileges([in]any catalog, [in]string schema, [in]string table, [in]string columnNamePattern) raises (SQLException); @@ -1257,28 +1780,28 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** gets a description of the access rights for each table available in a catalog. Note that a table privilege applies to one or more columns in the table. It would be wrong to assume that - this priviledge applies to all columns (this may be true for - some systems but is not true for all.) + this priviledge applies to all columns (this may be <TRUE/> for + some systems but is not <TRUE/> for all.) <p>Only privileges matching the schema and table name - criteria are returned. They are ordered by TABLE_SCHEM, + criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME, and PRIVILEGE. </p> <p>Each privilige description has the following columns: </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name </li> <li> - <b>GRANTOR</b> =&gt; grantor of access (may be null) + <b>GRANTOR</b> =&gt; grantor of access (may be <NULL/>) </li> <li> <b>GRANTEE</b> string =&gt; grantee of access @@ -1289,9 +1812,19 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>IS_GRANTABLE</b> string =&gt; "YES" if grantee is permitted - to grant to others; "NO" if not; null if unknown + to grant to others; "NO" if not; <NULL/> if unknown </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param tableNamePattern + a table name pattern + @returns + each row is a table privilege description + @throws SQLException + if a database access error occurs. */ XResultSet getTablePrivileges([in]any catalog, [in]string schemaPattern, [in]string tableNamePattern) raises (SQLException); @@ -1348,6 +1881,20 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + a table name + @param scope + the scope of interest; use same values as SCOPE + @param nullable + include columns that are nullable? + @returns + each row is a column description + @throws SQLException + if a database access error occurs. */ XResultSet getBestRowIdentifier([in]any catalog, [in]string schema, [in]string table, [in]long scope, [in] boolean nullable) @@ -1356,7 +1903,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getVersionColumns /** gets a description of a table's columns that are automatically - updated when any value in a row is updated. They are + updated when any value in a row is updated. They are unordered. @@ -1397,13 +1944,23 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + a table name + @returns + each row is a column description + @throws SQLException + if a database access error occurs. */ XResultSet getVersionColumns([in]any catalog, [in]string schema, [in]string table) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getPrimaryKeys - /** gets a description of a table's primary key columns. They + /** gets a description of a table's primary key columns. They are ordered by COLUMN_NAME. @@ -1411,10 +1968,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name @@ -1426,9 +1983,19 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>KEY_SEQ</b> short =&gt; sequence number within primary key </li> <li> - <b>PK_NAME</b> string =&gt; primary key name (may be null) + <b>PK_NAME</b> string =&gt; primary key name (may be <NULL/>) </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + a table name + @returns + each row is a primary key column description + @throws SQLException + if a database access error occurs. */ XResultSet getPrimaryKeys([in]any catalog, [in]string schema, [in]string table) raises (SQLException); @@ -1437,7 +2004,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys /** gets a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys - imported by a table). They are ordered by PKTABLE_CAT, + imported by a table). They are ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ. @@ -1446,11 +2013,11 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <ol> <li> <b>PKTABLE_CAT</b> string =&gt; primary key table catalog - being imported (may be null) + being imported (may be <NULL/>) </li> <li> <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema - being imported (may be null) + being imported (may be <NULL/>) </li> <li> <b>PKTABLE_NAME</b> string =&gt; primary key table name @@ -1461,10 +2028,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface being imported </li> <li> - <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be null) + <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be <NULL/>) </li> <li> - <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be null) + <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be <NULL/>) </li> <li> <b>FKTABLE_NAME</b> string =&gt; foreign key table name @@ -1517,10 +2084,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> <li> - <b>FK_NAME</b> string =&gt; foreign key name (may be null) + <b>FK_NAME</b> string =&gt; foreign key name (may be <NULL/>) </li> <li> - <b>PK_NAME</b> string =&gt; primary key name (may be null) + <b>PK_NAME</b> string =&gt; primary key name (may be <NULL/>) </li> <li> <b>DEFERRABILITY</b> short =&gt; can the evaluation of foreign key @@ -1535,6 +2102,16 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + a table name + @returns + each row is a primary key column description + @throws SQLException + if a database access error occurs. */ XResultSet getImportedKeys([in]any catalog, [in]string schema, [in]string table) raises (SQLException); @@ -1543,7 +2120,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys /** gets a description of the foreign key columns that reference a table's primary key columns (the foreign keys exported by a - table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, + table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ. @@ -1551,10 +2128,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>PKTABLE_CAT</b> string =&gt; primary key table catalog (may be null) + <b>PKTABLE_CAT</b> string =&gt; primary key table catalog (may be <NULL/>) </li> <li> - <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema (may be null) + <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema (may be <NULL/>) </li> <li> <b>PKTABLE_NAME</b> string =&gt; primary key table name @@ -1563,12 +2140,12 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>PKCOLUMN_NAME</b> string =&gt; primary key column name </li> <li> - <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be null) - being exported (may be null) + <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be <NULL/>) + being exported (may be <NULL/>) </li> <li> - <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be null) - being exported (may be null) + <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be <NULL/>) + being exported (may be <NULL/>) </li> <li> <b>FKTABLE_NAME</b> string =&gt; foreign key table name @@ -1623,10 +2200,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> <li> - <b>FK_NAME</b> string =&gt; foreign key name (may be null) + <b>FK_NAME</b> string =&gt; foreign key name (may be <NULL/>) </li> <li> - <b>PK_NAME</b> string =&gt; primary key name (may be null) + <b>PK_NAME</b> string =&gt; primary key name (may be <NULL/>) </li> <li> <b>DEFERRABILITY</b> short =&gt; can the evaluation of foreign key @@ -1641,6 +2218,16 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + a table name + @returns + each row is a foreign key column description + @throws SQLException + if a database access error occurs. */ XResultSet getExportedKeys([in]any catalog, [in]string schema, [in]string table) raises (SQLException); @@ -1651,7 +2238,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface table that reference the primary key columns of the primary key table (describe how one table imports another's key.) This should normally return a single foreign key/primary key pair - (most tables only import a foreign key from a table once.) They + (most tables only import a foreign key from a table once.). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ. @@ -1660,10 +2247,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>PKTABLE_CAT</b> string =&gt; primary key table catalog (may be null) + <b>PKTABLE_CAT</b> string =&gt; primary key table catalog (may be <NULL/>) </li> <li> - <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema (may be null) + <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema (may be <NULL/>) </li> <li> <b>PKTABLE_NAME</b> string =&gt; primary key table name @@ -1672,12 +2259,12 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>PKCOLUMN_NAME</b> string =&gt; primary key column name </li> <li> - <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be null) - being exported (may be null) + <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be <NULL/>) + being exported (may be <NULL/>) </li> <li> - <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be null) - being exported (may be null) + <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be <NULL/>) + being exported (may be <NULL/>) </li> <li> <b>FKTABLE_NAME</b> string =&gt; foreign key table name @@ -1732,10 +2319,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> <li> - <b>FK_NAME</b> string =&gt; foreign key name (may be null) + <b>FK_NAME</b> string =&gt; foreign key name (may be <NULL/>) </li> <li> - <b>PK_NAME</b> string =&gt; primary key name (may be null) + <b>PK_NAME</b> string =&gt; primary key name (may be <NULL/>) </li> <li> <b>DEFERRABILITY</b> short =&gt; can the evaluation of foreign key @@ -1750,6 +2337,22 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param primaryCatalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param primarySchema + a schema name; "" retrieves those without a schema + @param primaryTable + the table name that exports the key + @param foreignCatalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param foreignSchema + a schema name; "" retrieves those without a schema + @param foreignTable + the table name that imports the key + @returns + each row is a foreign key column description + @throws SQLException + if a database access error occurs. */ XResultSet getCrossReference( [in]any primaryCatalog, [in]string primarySchema, @@ -1779,15 +2382,15 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>LITERAL_PREFIX</b> string =&gt; prefix used to quote a literal - (may be null) + (may be <NULL/>) </li> <li> <b>LITERAL_SUFFIX</b> string =&gt; suffix used to quote a literal - (may be null) + (may be <NULL/>) </li> <li> <b>CREATE_PARAMS</b> string =&gt; parameters used in creating - the type (may be null) + the type (may be <NULL/>) </li> <li> <b>NULLABLE</b> short =&gt; can you use NULL for this type? @@ -1828,7 +2431,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>LOCAL_TYPE_NAME</b> string =&gt; localized version of type name - (may be null) + (may be <NULL/>) </li> <li> <b>MINIMUM_SCALE</b> short =&gt; minimum scale supported @@ -1846,6 +2449,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>NUM_PREC_RADIX</b> long =&gt; usually 2 or 10 </li> </ol> + @returns + each row is a SQL type description + @throws SQLException + if a database access error occurs. */ XResultSet getTypeInfo() raises (SQLException); //------------------------------------------------------------------------- @@ -1859,24 +2466,24 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name </li> <li> <b>NON_UNIQUE</b> boolean =&gt; Can index values be non-unique? - false when TYPE is tableIndexStatistic + <FALSE/> when TYPE is tableIndexStatistic </li> <li> - <b>INDEX_QUALIFIER</b> string =&gt; index catalog (may be null); - null when TYPE is tableIndexStatistic + <b>INDEX_QUALIFIER</b> string =&gt; index catalog (may be <NULL/>); + <NULL/> when TYPE is tableIndexStatistic </li> <li> - <b>INDEX_NAME</b> string =&gt; index name; null when TYPE is + <b>INDEX_NAME</b> string =&gt; index name; <NULL/> when TYPE is tableIndexStatistic </li> <li> @@ -1898,13 +2505,13 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface within index; zero when TYPE is tableIndexStatistic </li> <li> - <b>COLUMN_NAME</b> string =&gt; column name; null when TYPE is + <b>COLUMN_NAME</b> string =&gt; column name; <NULL/> when TYPE is tableIndexStatistic </li> <li> <b>ASC_OR_DESC</b> string =&gt; column sort sequence, "A" =&gt; ascending, - "D" =&gt; descending, may be null if sort sequence is not supported; - null when TYPE is tableIndexStatistic + "D" =&gt; descending, may be <NULL/> if sort sequence is not supported; + <NULL/> when TYPE is tableIndexStatistic </li> <li> <b>CARDINALITY</b> long =&gt; When TYPE is tableIndexStatistic, then @@ -1918,9 +2525,23 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>FILTER_CONDITION</b> string =&gt; Filter condition, if any. - (may be null) + (may be <NULL/>) </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + the table name that exports the key + @param unique + when <TRUE/>, return only indices for unique values; when <FALSE/>, return indices regardless of whether unique or not + @param approximate + when <TRUE/>, result is allowed to reflect approximate or out of data values; when <FALSE/>, results are requested to be accurate + @returns + each row is an index column description + @throws SQLException + if a database access error occurs. */ XResultSet getIndexInfo([in]any catalog, [in]string schema, [in]string table, [in]boolean unique, [in]boolean approximate) @@ -1929,6 +2550,13 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsResultSetType /** Does the database support the given result set type? + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsResultSetType([in]long setType) raises (SQLException); //------------------------------------------------------------------------- @@ -1936,6 +2564,16 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsResultSetConcurrency /** Does the database support the concurrency type in combination with the given result set type? + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @param concurrency + defined in + <type scop="com::sun::star::sdbc">ResultSetConcurrency</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsResultSetConcurrency([in]long setType, [in]long concurrency) @@ -1944,88 +2582,159 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::ownUpdatesAreVisible /** indicates whether a result set's own updates are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean ownUpdatesAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::ownDeletesAreVisible /** indicates whether a result set's own deletes are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean ownDeletesAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::ownInsertsAreVisible /** indicates whether a result set's own inserts are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean ownInsertsAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::othersUpdatesAreVisible /** indicates whether updates made by others are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean othersUpdatesAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::othersDeletesAreVisible /** indicates whether deletes made by others are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean othersDeletesAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::othersInsertsAreVisible /** indicates whether inserts made by others are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean othersInsertsAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::updatesAreDetected /** indicates whether or not a visible row update can be detected by - calling the method <code>XResultSet.rowUpdated</code>. + calling the method + <code>XResultSet.rowUpdated</code>. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean updatesAreDetected([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::deletesAreDetected /** indicates whether or not a visible row delete can be detected by - calling XResultSet.rowDeleted(). If deletesAreDetected() + calling + <member scope="com::sun::star::sdbc">XResultSet::rowDeleted()</member> + . If deletesAreDetected() returns <FALSE/>, then deleted rows are removed from the result set. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean deletesAreDetected([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::insertsAreDetected /** indicates whether or not a visible row insert can be detected - by calling XResultSet.rowInserted(). + by calling + <member scope="com::sun::star::sdbc">XResultSet::rowInserted().</member> + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean insertsAreDetected([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsBatchUpdates /** indicates whether the driver supports batch updates. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsBatchUpdates() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getUDTs /** Gets a description of the user-defined types defined in a particular - schema. Schema-specific UDTs may have type OBJECT, STRUCT, + schema. Schema-specific UDTs may have type OBJECT, STRUCT, or DISTINCT. <p>Only types matching the catalog, schema, type name, and type - criteria are returned. They are ordered by DATA_TYPE, TYPE_SCHEM, - and TYPE_NAME. The type name parameter may be a fully-qualified - name. In this case, the catalog and schemaPattern parameters are + criteria are returned. They are ordered by DATA_TYPE, TYPE_SCHEM, + and TYPE_NAME. The type name parameter may be a fully-qualified + name. In this case, the catalog and schemaPattern parameters are ignored. </p> <p>Each type description has the following columns: </p> <ol> <li> - <b>TYPE_CAT</b> string =&gt; the type's catalog (may be null) + <b>TYPE_CAT</b> string =&gt; the type's catalog (may be <NULL/>) </li> <li> - <b>TYPE_SCHEM</b> string =&gt; type's schema (may be null) + <b>TYPE_SCHEM</b> string =&gt; type's schema (may be <NULL/>) </li> <li> <b>TYPE_NAME</b> string =&gt; type name @@ -2045,6 +2754,18 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>Note:</b> If the driver does not support UDTs, an empty result set is returned. </p> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param typeNamePattern + a type name pattern; may be a fully-qualified name + @param types + a list of user-named types to include (OBJECT, STRUCT, or DISTINCT); <NULL/> returns all types + @returns + each row is a type description + @throws SQLException + if a database access error occurs. */ XResultSet getUDTs([in]any catalog, [in]string schemaPattern, [in]string typeNamePattern, [in]sequence<long> types) @@ -2053,6 +2774,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getConnection /** retrieves the connection that produced this metadata object. + @returns + the Connection object + @throws SQLException + if a database access error occurs. */ XConnection getConnection() raises (SQLException); }; @@ -2063,6 +2788,12 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.9.2.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.9 2001/11/28 15:32:14 jsc + remove double closed comment + Revision 1.8 2001/11/02 12:47:42 mi needs <TRUE/> instead of <TRUE> etc. @@ -2076,7 +2807,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface remove interfaceheader with uik and remove [const] in method definitions Revision 1.4 2000/12/14 12:53:39 mi - <true></true> -> <TRUE/> and same with FALSE + <<TRUE/>></<TRUE/>> -> <TRUE/> and same with FALSE Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/XDriver.idl b/offapi/com/sun/star/sdbc/XDriver.idl index 6d823e50af68..735fffd35681 100644 --- a/offapi/com/sun/star/sdbc/XDriver.idl +++ b/offapi/com/sun/star/sdbc/XDriver.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDriver.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: oj $ $Date: 2002-06-25 06:12:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -216,40 +216,4 @@ interface XDriver: com::sun::star::uno::XInterface }; }; }; }; -/*=========================================================================== - $Log: not supported by cvs2svn $ - Revision 1.7.2.2 2002/06/25 06:10:18 oj - new service for ConnectionProperties implemented - - Revision 1.7.2.1 2002/02/18 08:58:22 oj - #97563# parameter,return value and exception description - - Revision 1.7 2001/11/01 16:46:46 mi - proofreading and corrections from Richard Holt - - Revision 1.6 2001/03/16 16:41:35 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.5 2000/12/19 13:46:04 mi - syntax errors in documentation fixed - - Revision 1.4 2000/12/14 12:53:39 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:35 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:41 hjs - initial import - - Revision 1.4 2000/09/11 11:52:43 mi - documentation merged from XML - - Revision 1.2 1999/12/13 13:47:55 dg - #70278# XSQLErrorBroadcaster removed - - Revision 1.1 1999/11/24 08:41:05 dg - new StarDataBaseConnectivity - -===========================================================================*/ #endif diff --git a/offapi/com/sun/star/sdbc/XDriverAccess.idl b/offapi/com/sun/star/sdbc/XDriverAccess.idl index 65f61807a1bf..be612451f1ad 100644 --- a/offapi/com/sun/star/sdbc/XDriverAccess.idl +++ b/offapi/com/sun/star/sdbc/XDriverAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDriverAccess.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:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,14 +72,21 @@ interface XDriver; // DocMerge from xml: interface com::sun::star::sdbc::XDriverAccess -/** provides the access of sdbc driver components@see com::sun::star::sdbc::XDriverManager - @see com::sun::star::sdbc::XDriver +/** provides the access of sdbc driver components + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::XDriver */ interface XDriverAccess: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::XDriverAccess::getDriverByURL - /** get a driver which accepts a given url.@see XDriver::acceptsURL + /** get a driver which accepts a given url.@see com::sun::star::sdbc::XDriver::acceptsURL + @param url + a database url of the form sdbc:subprotocol:subname + @returns + a Driver that can connect to the URL + @throws SQLException + if a database access error occurs. */ XDriver getDriverByURL([in]string url); }; @@ -90,6 +97,12 @@ interface XDriverAccess: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 09:00:56 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 diff --git a/offapi/com/sun/star/sdbc/XDriverManager.idl b/offapi/com/sun/star/sdbc/XDriverManager.idl index 8200bd61a962..6bfdac7cbeee 100644 --- a/offapi/com/sun/star/sdbc/XDriverManager.idl +++ b/offapi/com/sun/star/sdbc/XDriverManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDriverManager.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: oj $ $Date: 2002-06-25 06:12:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -162,34 +162,4 @@ interface XDriverManager: com::sun::star::uno::XInterface }; }; }; }; -/*=========================================================================== - $Log: not supported by cvs2svn $ - Revision 1.4.16.2 2002/06/25 06:10:18 oj - new service for ConnectionProperties implemented - - 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 - - Revision 1.1.1.1 2000/09/18 23:35:42 hjs - initial import - - Revision 1.5 2000/09/11 11:52:43 mi - documentation merged from XML - - Revision 1.3 1999/12/14 12:05:46 dg - #70278# CompareBookmark removed - - Revision 1.2 1999/12/13 13:47:55 dg - #70278# XSQLErrorBroadcaster removed - - Revision 1.1 1999/11/24 08:41:06 dg - new StarDataBaseConnectivity - -===========================================================================*/ #endif diff --git a/offapi/com/sun/star/sdbc/XMultipleResults.idl b/offapi/com/sun/star/sdbc/XMultipleResults.idl index 820a4480194f..d4aeb8819070 100644 --- a/offapi/com/sun/star/sdbc/XMultipleResults.idl +++ b/offapi/com/sun/star/sdbc/XMultipleResults.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMultipleResults.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,23 +79,35 @@ interface XResultSet; SQL statement. - <p>Under some (uncommon) situations a single SQL statement may return + <p> + Under some (uncommon) situations a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an - unknown SQL string. The methods <code>getMoreResults</code>, - <code>getResultSet</code> and <code>getUpdateCount</code> let you navigate - through multiple results. - - </p>@see com::sun::star::sdbc::XStatement + unknown SQL string. The methods + <member scope="com::sun::star::sdbc">XMultipleResults::getMoreResults()</member> + , + <member scope="com::sun::star::sdbc">XMultipleResults::getResultSet()</member> + and + <member scope="com::sun::star::sdbc">XMultipleResults::getUpdateCount()</member> + let you navigate through multiple results. + + </p> + @see com::sun::star::sdbc::XStatement @see com::sun::star::sdbc::XPreparedStatement */ interface XMultipleResults: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::XMultipleResults::getResultSet - /** returns the current result as a <code>ResultSet</code> object. + /** returns the current result as a + <type scope="com::sun::star::sdbc">ResultSet</type> + object. This method should be called only once per result. + @returns + the ResultSet object + @throws SQLException + if a database access error occurs. */ XResultSet getResultSet() raises (SQLException); //------------------------------------------------------------------------- @@ -104,9 +116,14 @@ interface XMultipleResults: com::sun::star::uno::XInterface /** returns the current result as an update count. - <p>if the result is a ResultSet or there are no more results, -1 + <p> + If the result is a ResultSet or there are no more results, -1 is returned. This method should be called only once per result. </p> + @returns + the current result as an update count. + @throws SQLException + if a database access error occurs. */ long getUpdateCount() raises (SQLException); //------------------------------------------------------------------------- @@ -116,12 +133,15 @@ interface XMultipleResults: com::sun::star::uno::XInterface this result is a ResultSet. This method also implicitly closes any current ResultSet obtained with getResultSet. - - - <p>There are no more results when <code>(!getMoreResults() &amp;&amp; + <p> + There are no more results when <code>(!getMoreResults() &amp;&amp; getUpdateCount() == -1)</code>. </p> + @returns + <TRUE/> if there exists more ResultSet objects + @throws SQLException + if a database access error occurs. */ boolean getMoreResults() raises (SQLException); }; @@ -132,6 +152,12 @@ interface XMultipleResults: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/14 12:53:39 mi <true></true> -> <TRUE/> and same with FALSE diff --git a/offapi/com/sun/star/sdbc/XOutParameters.idl b/offapi/com/sun/star/sdbc/XOutParameters.idl index 130228edb9f0..a82173c920fb 100644 --- a/offapi/com/sun/star/sdbc/XOutParameters.idl +++ b/offapi/com/sun/star/sdbc/XOutParameters.idl @@ -2,9 +2,9 @@ * * $RCSfile: XOutParameters.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:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,28 +76,36 @@ /** is used to register Out-Parameters for stored procedures. - <p>SDBC provides a stored procedure SQL escape that allows stored procedures + <p> + SDBC provides a stored procedure SQL escape that allows stored procedures to be called in a standard way for all RDBMSs. This escape syntax has one form that includes a result parameter and one that does not. If used, the result parameter must be registered as an OUT parameter. The other parameters can be used for input, output, or both. Parameters are referred to sequentially, - by number. The first parameter is 1.</p> + by number. The first parameter is 1. + </p> */ interface XOutParameters: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::XOutParameters::registerOutParameter /** registers the designated output parameter. This version of - the method <code>registerOutParameter</code> + the method + <member scope="com::sun::star::sdbc">XOutParameters::registerOutParameter()</member> should be used for a user-named or REF output parameter. Examples of user-named types include: STRUCT, DISTINCT, OBJECT, and named array types. - <p>Before executing a stored procedure call, you must explicitly - call <code>registerOutParameter</code> to register the type from - <code>DataType</code> for each OUT parameter. - <br>For a user-named parameter the fully-qualified SQL type name of the + <p> + Before executing a stored procedure call, you must explicitly + call + <member scope="com::sun::star::sdbc">XOutParameters::registerOutParameter()</member> + to register the type from + <type scope="com::sun::star::sdbc">DataType</type> + for each OUT parameter. + <br/> + For a user-named parameter the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. An SDBC driver that does not need the type code and type name information @@ -111,9 +119,19 @@ interface XOutParameters: com::sun::star::uno::XInterface </p> <p> <b>Note:</b> When reading the value of an out parameter, you - must use the <code>getXXX</code> method whose type XXX corresponds to the + must use the + <code>getXXX</code> + method whose type XXX corresponds to the parameter's registered SQL type. </p> + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param sqlType + the type of the column to register + @param typeName + the name of the type + @throws SQLException + if a database access error occurs. */ void registerOutParameter([in]long parameterIndex, [in]long sqlType, [in]string typeName) @@ -122,16 +140,35 @@ interface XOutParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XOutParameters::registerNumericOutParameter /** registers the OUT parameter in ordinal position - <code>parameterIndex</code> to the SDBC type <code>sqlType</code>. All + <code>parameterIndex</code> + to the SDBC type + <code>sqlType</code> + . All OUT parameters must be registered before a stored procedure is executed. - <p>The SDBC type specified by <code>sqlType</code> for an OUT parameter - determines the type that must be used in the <code>get</code> method to - read the value of that parameter. - This version of <code>registerOutParameter</code> should be - used when the parameter is of SDBC type <code>NUMERIC</code> - or <code>DECIMAL</code>. + <p> + The SDBC type specified by + <code>sqlType</code> + for an OUT parameter determines the type that must be used in the + <code>get</code> + method to read the value of that parameter. + This version of + <member scope="com::sun::star::sdbc">XOutParameters::registerOutParameter()</member> + should be + used when the parameter is of SDBC type + <member scope="com::sun::star::sdbc">DataType::NUMERIC</member> + or + <member scope="com::sun::star::sdbc">DataType::DECIMAL</member> + . + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param sqlType + the type of the column to register + @param scale + the scale of the type + @throws SQLException + if a database access error occurs. </p> */ void registerNumericOutParameter([in]long parameterIndex, [in]long sqlType, @@ -145,6 +182,12 @@ interface XOutParameters: 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 diff --git a/offapi/com/sun/star/sdbc/XParameters.idl b/offapi/com/sun/star/sdbc/XParameters.idl index 67782c41d09d..821cc817d6eb 100644 --- a/offapi/com/sun/star/sdbc/XParameters.idl +++ b/offapi/com/sun/star/sdbc/XParameters.idl @@ -2,9 +2,9 @@ * * $RCSfile: XParameters.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -102,20 +102,22 @@ interface XClob; <b>Note:</b> The setXXX methods for setting IN parameter values must specify types that are compatible with the defined SQL type of the input parameter. For instance, if the IN parameter has SQL type - Integer, then the method <code>setLong</code> should be used. + Integer, then the method + <member scope="com::sun::star::sdbc">XParameters::setInt()</member> + should be used. </p> - <p>If arbitrary parameter type conversions are required, the method - <code>setObject</code> should be used with a target SQL type. - <br> - <br> - Example of setting a parameter; <code>con</code> is an active connection. + <p> + If arbitrary parameter type conversions are required, the method + <member scope="com::sun::star::sdbc">XParameters::setObject()</member> + should be used with a target SQL type. + <br/> + <br/> + Example of setting a parameter; + <code>con</code> + is an active connection. </p> - - - - @example <listing>pstmt = con.prepareStatement("UPDATE EMPLOYEES SET SALARY = ? WHERE ID = ?") pstmt.setDouble(1, 153833.00) pstmt.setLong(2, 110592) @@ -145,12 +147,21 @@ interface XParameters: com::sun::star::uno::XInterface the name is the type name of the parameter itself. For a REF parameter the name is the type name of the referenced type. If a SDBC driver does not need the type code or type name information, - it may ignore it.<br> + it may ignore it. + <br/> Although it is intended for user-named and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-named or REF type, the given typeName is ignored. </p> + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param sqlType + the type of the column to set to <NULL/> + @param typeName + the name of the type + @throws SQLException + if a database access error occurs. */ void setObjectNull([in]long parameterIndex, [in]long sqlType, @@ -160,6 +171,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setBoolean /** sets the designated parameter to a boolean value. The driver converts this to a SQL BIT value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setBoolean([in]long parameterIndex, [in]boolean x) raises (SQLException); @@ -168,6 +185,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setByte /** sets the designated parameter to a byte value. The driver converts this to a SQL TINYINT value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setByte([in]long parameterIndex, [in]byte x) raises (SQLException); //------------------------------------------------------------------------- @@ -175,6 +198,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setShort /** sets the designated parameter to a short value. The driver converts this to a SQL SMALLINT value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setShort([in]long parameterIndex, [in]short x) raises (SQLException); //------------------------------------------------------------------------- @@ -182,6 +211,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setInt /** sets the designated parameter to a long value. The driver converts this to a SQL INTEGER value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setInt([in]long parameterIndex, [in]long x) raises (SQLException); //------------------------------------------------------------------------- @@ -189,6 +224,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setLong /** sets the designated parameter to a hyper value. The driver converts this to a SQL BIGINT value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setLong([in]long parameterIndex, [in]hyper x) raises (SQLException); //------------------------------------------------------------------------- @@ -196,6 +237,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setFloat /** sets the designated parameter to a float value. The driver converts this to a SQL FLOAT value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setFloat([in]long parameterIndex, [in]float x) raises (SQLException); //------------------------------------------------------------------------- @@ -203,6 +250,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setDouble /** sets the designated parameter to a double value. The driver converts this to a SQL DOUBLE value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setDouble([in]long parameterIndex, [in]double x) raises (SQLException); //------------------------------------------------------------------------- @@ -212,6 +265,12 @@ interface XParameters: com::sun::star::uno::XInterface to a SQL VARCHAR or LONGVARCHAR value (depending on the argument's size relative to the driver's limits on VARCHARs) when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setString([in]long parameterIndex, [in]string x) raises (SQLException); //------------------------------------------------------------------------- @@ -221,6 +280,12 @@ interface XParameters: com::sun::star::uno::XInterface this to a SQL VARBINARY or LONGVARBINARY (depending on the argument's size relative to the driver's limits on VARBINARYs) when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setBytes([in]long parameterIndex, [in]sequence<byte> x) raises (SQLException); @@ -229,6 +294,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setDate /** sets the designated parameter to a date value. The driver converts this to a SQL DATE value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setDate([in]long parameterIndex, [in]com::sun::star::util::Date x) raises (SQLException); @@ -237,6 +308,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setTime /** sets the designated parameter to a time value. The driver converts this to a SQL TIME value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setTime([in]long parameterIndex, [in]com::sun::star::util::Time x) raises (SQLException); @@ -246,6 +323,12 @@ interface XParameters: com::sun::star::uno::XInterface /** sets the designated parameter to a datetime value. The driver converts this to a SQL TIMESTAMP value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setTimestamp([in]long parameterIndex, [in]com::sun::star::util::DateTime x) raises (SQLException); @@ -256,8 +339,16 @@ interface XParameters: com::sun::star::uno::XInterface the specified number of bytes. When a very large binary value is input to a LONGVARBINARY or LONGVARCHAR parameter, it may be more practical to send it via an - <type scope="com::sun::star::io">XInputStream</type>. SDBC will read the data - from the stream as needed, until it reaches end-of-file. + <type scope="com::sun::star::io">XInputStream</type> + . SDBC will read the data from the stream as needed, until it reaches end-of-file. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @param length + the number of bytes in the stream + @throws SQLException + if a database access error occurs. */ void setBinaryStream([in]long parameterIndex, [in]com::sun::star::io::XInputStream x, @@ -269,8 +360,16 @@ interface XParameters: com::sun::star::uno::XInterface the specified number of bytes. When a very large binary value is input to a LONGVARCHAR parameter, it may be more practical to send it via a - <type scope="com::sun::star::io">XInputStream</type>. SDBC will read the data - from the stream as needed, until it reaches end-of-file. + <type scope="com::sun::star::io">XInputStream</type> + . SDBC will read the data from the stream as needed, until it reaches end-of-file. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @param length + the number of characters in the stream + @throws SQLException + if a database access error occurs. */ void setCharacterStream([in]long parameterIndex, [in]com::sun::star::io::XInputStream x, @@ -293,6 +392,12 @@ interface XParameters: com::sun::star::uno::XInterface <p>Note that this method may be used to pass database-specific abstract data types. </p> + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setObject([in]long parameterIndex, [in]any x) raises (SQLException); @@ -315,6 +420,22 @@ interface XParameters: com::sun::star::uno::XInterface <p>Note that this method may be used to pass database-specific abstract data types. </p> + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @param targetSqlType + the SQL type (as defined in + <type scope="com::sun::star::sdbc">DataType</type> + ) to be sent to the database. The scale argument may further qualify this type. + @param scale + for + <member scope="com::sun::star::sdbc">DataType::DECIMAL</member> + or + <member scope="com::sun::star::sdbc">DataType::NUMERIC</member> + types, this is the number of digits after the decimal point. For all other types, this value will be ignored. + @throws SQLException + if a database access error occurs. */ void setObjectWithInfo([in]long parameterIndex, [in]any x, [in]long targetSqlType, [in]long scale) @@ -323,24 +444,48 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setRef /** sets a REF(&lt;structured-type&gt;) parameter. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setRef ([in]long parameterIndex, [in]XRef x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setBlob /** sets a BLOB parameter. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setBlob ([in]long parameterIndex, [in]XBlob x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setClob /** sets a CLOB parameter. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setClob ([in]long parameterIndex, [in]XClob x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setArray /** sets an Array parameter. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setArray ([in]long parameterIndex, [in]XArray x) raises (SQLException); @@ -356,6 +501,8 @@ interface XParameters: com::sun::star::uno::XInterface release the resources used by the current parameter values; this can be done by calling clearParameters. </p> + @throws SQLException + if a database access error occurs. */ void clearParameters() raises (SQLException); }; @@ -366,6 +513,12 @@ interface XParameters: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XPooledConnection.idl b/offapi/com/sun/star/sdbc/XPooledConnection.idl index 671a17e17f04..cf024d9bcf82 100644 --- a/offapi/com/sun/star/sdbc/XPooledConnection.idl +++ b/offapi/com/sun/star/sdbc/XPooledConnection.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPooledConnection.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,8 +83,14 @@ interface XConnection; <!-- JRH: unclear meaning --> - <p>When the method <code>getConnection</code> is called, - the PooledConnection return the connection which is pooled. + <p> + PoolConnections are handled by the connection pool. + </p> + <p> + When the method + <member scope="com::sun::star::sdbc">XPooledConnection::getConnection()</member> + is called, the PooledConnection returns the connection which is pooled. + </p> @see com::sun::star::sdbc::XConnection */ @@ -94,6 +100,10 @@ interface XPooledConnection: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XPooledConnection::getConnection /** return the connection which is pooled + @returns + the pooled Connection object + @throws SQLException + if a database access error occurs. */ XConnection getConnection() raises (SQLException); diff --git a/offapi/com/sun/star/sdbc/XPreparedBatchExecution.idl b/offapi/com/sun/star/sdbc/XPreparedBatchExecution.idl index 0ff977832ea9..ff7a21551915 100644 --- a/offapi/com/sun/star/sdbc/XPreparedBatchExecution.idl +++ b/offapi/com/sun/star/sdbc/XPreparedBatchExecution.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPreparedBatchExecution.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:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,21 +76,29 @@ /** is used for batch execution on PreparedStatements. - <p>A PreparedStatement uses one precompiled SQL Statement. In batch execution + <p> + A + <type scope="com::sun::star::sdbc">PreparedStatement</type> + uses one precompiled SQL Statement. In batch execution it is possible to set collection of parameter settings, which are executed in - one batch job.</p> + one batch job. + </p> */ interface XPreparedBatchExecution: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::XPreparedBatchExecution::addBatch /** adds a set of parameters to the batch. + @throws SQLException + if a database access error occurs. */ void addBatch() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XPreparedBatchExecution::clearBatch /** makes the set of commands in the current batch empty. + @throws SQLException + if a database access error occurs. */ void clearBatch() raises (SQLException); //------------------------------------------------------------------------- @@ -113,6 +121,12 @@ interface XPreparedBatchExecution: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 09:00:56 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 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 diff --git a/offapi/com/sun/star/sdbc/XRef.idl b/offapi/com/sun/star/sdbc/XRef.idl index 976644d01ed7..42571162d56c 100644 --- a/offapi/com/sun/star/sdbc/XRef.idl +++ b/offapi/com/sun/star/sdbc/XRef.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRef.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 @@ -84,6 +84,10 @@ interface XRef: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XRef::getBaseTypeName /** gets the fully-qualified SQL structured type name of the referenced item. + @returns + the base type name + @throws SQLException + if a database access error occurs. */ string getBaseTypeName() raises (SQLException); }; @@ -94,6 +98,12 @@ interface XRef: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 09:00:56 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 diff --git a/offapi/com/sun/star/sdbc/XResultSet.idl b/offapi/com/sun/star/sdbc/XResultSet.idl index 3644365a7e58..12d7f83b2ccc 100644 --- a/offapi/com/sun/star/sdbc/XResultSet.idl +++ b/offapi/com/sun/star/sdbc/XResultSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XResultSet.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * 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 @@ -75,13 +75,18 @@ interface XStatement; // DocMerge from xml: interface com::sun::star::sdbc::XResultSet -/** provides the navigation on a table of data. A ResultSet - object is usually generated by executing a Statement. +/** provides the navigation on a table of data. A + <type scope="com::sun::star::sdbc">ResultSet</type> + object is usually generated by executing a + <type scope="com::sun::star::sdbc">Statement</type> + . - <p>A ResultSet maintains a cursor pointing to its current row of + <p> + A ResultSet maintains a cursor pointing to its current row of data. Initially the cursor is positioned before the first row. - The 'next' method moves the cursor to the next row.</p> + The 'next' method moves the cursor to the next row. + </p> */ interface XResultSet: com::sun::star::uno::XInterface { @@ -91,14 +96,21 @@ interface XResultSet: com::sun::star::uno::XInterface /** moves the cursor down one row from its current position. - <p>A ResultSet cursor is initially positioned before the first row; the + <p> + A ResultSet cursor is initially positioned before the first row; the first call to next makes the first row the current row; the second call makes the second row the current row, and so on. </p> <p>If an input stream is open for the current row, a call - to the method <code>moveNext</code> will implicitly close it. + to the method + <code>next</code> + will implicitly close it. The ResultSet's warning chain is cleared when a new row is read. </p> + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean next() raises (SQLException); //------------------------------------------------------------------------- @@ -106,6 +118,10 @@ interface XResultSet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSet::isBeforeFirst /** indicates whether the cursor is before the first row in the result set. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isBeforeFirst() raises (SQLException); //------------------------------------------------------------------------- @@ -113,12 +129,20 @@ interface XResultSet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSet::isAfterLast /** indicates whether the cursor is after the last row in the result set. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isAfterLast() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSet::isFirst /** indicates whether the cursor is on the first row of the result set. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isFirst() raises (SQLException); //------------------------------------------------------------------------- @@ -127,10 +151,19 @@ interface XResultSet: com::sun::star::uno::XInterface /** indicates whether the cursor is on the last row of the result set. - <p>Note: Calling the method <code>isAtLast</code> may be expensive - because the SDBC driver might need to fetch ahead one row in order + <p> + <B> + Note: + </B> + Calling the method + <code>isAtLast</code> + may be expensive because the SDBC driver might need to fetch ahead one row in order to determine whether the current row is the last row in the result set. </p> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isLast() raises (SQLException); //------------------------------------------------------------------------- @@ -138,6 +171,8 @@ interface XResultSet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSet::beforeFirst /** moves the cursor to the front of the result set, just before the first row. Has no effect if the result set contains no rows. + @throws SQLException + if a database access error occurs. */ void beforeFirst() raises (SQLException); //------------------------------------------------------------------------- @@ -145,18 +180,28 @@ interface XResultSet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSet::afterLast /** moves the cursor to the end of the result set, just after the last row. Has no effect if the result set contains no rows. + @throws SQLException + if a database access error occurs. */ void afterLast() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSet::first /** moves the cursor to the first row in the result set. + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean first() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSet::last /** moves the cursor to the last row in the result set. + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean last() raises (SQLException); //------------------------------------------------------------------------- @@ -164,6 +209,10 @@ interface XResultSet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSet::getRow /** retrieves the current row number. The first row is number 1, the second number 2, and so on. + @returns + the current position + @throws SQLException + if a database access error occurs. */ long getRow() raises (SQLException); //------------------------------------------------------------------------- @@ -172,24 +221,34 @@ interface XResultSet: com::sun::star::uno::XInterface /** moves the cursor to the given row number in the result set. - <p>If the row number is positive, the cursor moves to + <p> + If the row number is positive, the cursor moves to the given row number with respect to the beginning of the result set. The first row is row 1, the second is row 2, and so on. </p> - <p>If the given row number is negative, the cursor moves to + <p> + If the given row number is negative, the cursor moves to an absolute row position with respect to the end of the result set. For example, calling - <code>moveToPosition(-1)</code> positions the - cursor on the last row, <code>moveToPosition(-2)</code> indicates the - next-to-last row, and so on. + <code>absolute(-1)</code> + positions the + cursor on the last row, + <code>absolute(-2)</code> + indicates the next-to-last row, and so on. </p> - <p>An attempt to position the cursor beyond the first/last row in + <p> + An attempt to position the cursor beyond the first/last row in the result set leaves the cursor before/after the first/last row, respectively. </p> - <p>Note: Calling <code>moveToPosition(1)</code> is the same - as calling <code>moveToFirst()</code>. + <p> + Note: Calling + <code>absolute(1)</code> + is the same + as calling + <member scope="com::sun::star::sdbc">XResultSet::first()</member> + . Calling <code>moveToPosition(-1)</code> is the same as calling <code>moveToLast()</code>. </p> @@ -204,16 +263,26 @@ interface XResultSet: com::sun::star::uno::XInterface <p> Attempting to move beyond the first/last row in the result set positions the cursor before/after - the first/last row. Calling <code>moveRelative(0)</code> is valid, but does - not change the cursor position. - + the first/last row. Calling + <code>relative(0)</code> + is valid, but does not change the cursor position. </p> - <p>Note: Calling <code>moveRelative(1)</code> - is different from calling <code>moveNext()</code> - because is makes sense to call <code>moveNext()</code> when there is - no current row, for example, when the cursor is positioned before + <p> + Note: Calling + <code>relative(1)</code> + is different from calling + <member scope="com::sun::star::sdbc">XResultSet::next()</member> + because is makes sense to call + <code>next()</code> + when there is no current row, for example, when the cursor is positioned before the first row or after the last row of the result set. </p> + @param rows + how many rows should be moved relative to the current row + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean relative([in]long rows) raises (SQLException); //------------------------------------------------------------------------- @@ -222,10 +291,19 @@ interface XResultSet: com::sun::star::uno::XInterface /** moves the cursor to the previous row in the result set. - <p>Note: <code>previous()</code> is not the same as - <code>relative(-1)</code> because it - makes sense to call <code>previous()</code> when there is no current row. + <p> + Note: + <code>previous()</code> + is not the same as + <code>relative(-1)</code> + because it makes sense to call + <code>previous()</code> + when there is no current row. </p> + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean previous() raises (SQLException); //------------------------------------------------------------------------- @@ -233,19 +311,29 @@ interface XResultSet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSet::refreshRow /** refreshes the current row with its most recent value in the database. Cannot be called when on the insert row. - The <code>refreshRow</code> method provides a way for an application to + The + <code>refreshRow</code> + method provides a way for an application to explicitly tell the SDBC driver to refetch a row(s) from the - database. An application may want to call <code>refreshRow</code> when - caching or prefetching is being done by the SDBC driver to + database. An application may want to call + <code>refreshRow</code> + when caching or prefetching is being done by the SDBC driver to fetch the latest value of a row from the database. The SDBC driver may actually refresh multiple rows at once if the fetch size is greater than one. All values are refetched subject to the transaction isolation - level and cursor sensitivity. If <code>refreshRow</code> is called after - calling <code>updateXXX</code>, but before calling <code>updateRow</code>, - then the updates made to the row are lost. - Calling the method <code>refreshRow</code> frequently will likely - slow performance. + level and cursor sensitivity. If + <code>refreshRow</code> + is called after calling + <code>updateXXX</code> + , but before calling + <member scope="com::sun::star::sdbc">XResultSet::updateRow()</member> + , then the updates made to the row are lost. + Calling the method + <code>refreshRow</code> + frequently will likely slow performance. + @throws SQLException + if a database access error occurs. */ void refreshRow() raises (SQLException); //------------------------------------------------------------------------- @@ -253,6 +341,10 @@ interface XResultSet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSet::rowUpdated /** indicates whether the current row has been updated. The value returned depends on whether or not the result set can detect updates. + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean rowUpdated() raises (SQLException); //------------------------------------------------------------------------- @@ -260,6 +352,10 @@ interface XResultSet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSet::rowInserted /** indicates whether the current row has had an insertion. The value returned depends on whether or not the result set can detect visible inserts. + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean rowInserted() raises (SQLException); //------------------------------------------------------------------------- @@ -269,14 +365,26 @@ interface XResultSet: com::sun::star::uno::XInterface a visible "hole" in a result set. This method can be used to detect holes in a result set. The value returned depends on whether or not the result set can detect deletions. + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean rowDeleted() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSet::getStatement - /** returns the Statement that produced this <code>ResultSet</code> object. - If the result set was generated some other way, such as by an - <code>XDatabaseMetaData</code> method, this method returns <NULL/>. + /** returns the Statement that produced this + <type scope="com::sun::star::sdbc">ResultSet</type> + object. If the result set was generated some other way, such as by an + <type scope="com::sun::star::sdbc">XDatabaseMetaData</type> + method, this method returns + <NULL/> + . + @returns + the statement object + @throws SQLException + if a database access error occurs. */ com::sun::star::uno::XInterface getStatement() raises (SQLException); }; @@ -287,6 +395,12 @@ interface XResultSet: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/19 13:46:04 mi syntax errors in documentation fixed diff --git a/offapi/com/sun/star/sdbc/XResultSetMetaData.idl b/offapi/com/sun/star/sdbc/XResultSetMetaData.idl index a0510c511aed..692e8598f092 100644 --- a/offapi/com/sun/star/sdbc/XResultSetMetaData.idl +++ b/offapi/com/sun/star/sdbc/XResultSetMetaData.idl @@ -2,9 +2,9 @@ * * $RCSfile: XResultSetMetaData.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 @@ -81,48 +81,94 @@ interface XResultSetMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnCount /** returns the number of columns in this ResultSet. + @returns + the column count + @throws SQLException + if a database access error occurs. */ long getColumnCount() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isAutoIncrement /** indicates whether the column is automatically numbered, thus read-only. + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isAutoIncrement([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isCaseSensitive /** indicates whether a column's case matters. + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isCaseSensitive([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isSearchable /** indicates whether the column can be used in a where clause. + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isSearchable([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isCurrency /** indicates whether the column is a cash value. + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isCurrency([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isNullable /** indicates the nullability of values in the designated column.@see com::sun::star::sdbc::ColumnValue + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long isNullable([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isSigned /** indicates whether values in the column are signed numbers. + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isSigned([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnDisplaySize /** indicates the column's normal max width in chars. + @param column + the first column is 1, the second is 2, + @returns + the normal maximum number of characters allowed as the width of the designated column + @throws SQLException + if a database access error occurs. */ long getColumnDisplaySize([in]long column) raises (SQLException); //------------------------------------------------------------------------- @@ -130,80 +176,159 @@ interface XResultSetMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnLabel /** gets the suggested column title for use in printouts and displays. + @param column + the first column is 1, the second is 2, + @returns + the suggested column title + @throws SQLException + if a database access error occurs. */ string getColumnLabel([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnName /** gets a column's name. + @param column + the first column is 1, the second is 2, + @returns + the column name + @throws SQLException + if a database access error occurs. */ string getColumnName([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getSchemaName /** gets a column's table's schema. + @param column + the first column is 1, the second is 2, + @returns + the schema name + @throws SQLException + if a database access error occurs. */ string getSchemaName([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getPrecision /** gets a column's number of decimal digits. + @param column + the first column is 1, the second is 2, + @returns + precision + @throws SQLException + if a database access error occurs. */ long getPrecision([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getScale /** gets a column's number of digits to right of the decimal point. + @param column + the first column is 1, the second is 2, + @returns + scale + @throws SQLException + if a database access error occurs. */ long getScale([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getTableName /** gets a column's table name. + @param column + the first column is 1, the second is 2, + @returns + the table name + @throws SQLException + if a database access error occurs. */ string getTableName([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getCatalogName /** gets a column's table's catalog name. + @param column + the first column is 1, the second is 2, + @returns + the catalog name + @throws SQLException + if a database access error occurs. */ string getCatalogName([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnType /** retrieves a column's SQL type. + @param column + the first column is 1, the second is 2, + @returns + the column type + @throws SQLException + if a database access error occurs. */ long getColumnType([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnTypeName /** retrieves a column's database-specific type name. + @param column + the first column is 1, the second is 2, + @returns + the type name + @throws SQLException + if a database access error occurs. */ string getColumnTypeName([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isReadOnly /** indicates whether a column is definitely not writable. + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isReadOnly([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isWritable /** indicates whether it is possible for a write on the column to succeed. + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isWritable([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isDefinitelyWritable /** indicates whether a write on the column will definitely succeed. + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isDefinitelyWritable([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnServiceName /** returns the fully-qualified name of the service whose instances - are manufactured if the method <code>ResultSet.getObject</code> + are manufactured if the method + <member scope="com::sun::star::sdbc">XResultSet::.getObject()</member> is called to retrieve a value from the column. + @param column + the first column is 1, the second is 2, + @returns + the service name + @throws SQLException + if a database access error occurs. */ string getColumnServiceName([in]long column) raises (SQLException); }; @@ -214,6 +339,12 @@ interface XResultSetMetaData: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 09:00:56 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 diff --git a/offapi/com/sun/star/sdbc/XResultSetMetaDataSupplier.idl b/offapi/com/sun/star/sdbc/XResultSetMetaDataSupplier.idl index 8478a96bf86d..b0effe103d37 100644 --- a/offapi/com/sun/star/sdbc/XResultSetMetaDataSupplier.idl +++ b/offapi/com/sun/star/sdbc/XResultSetMetaDataSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XResultSetMetaDataSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * 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 @@ -78,15 +78,24 @@ interface XResultSetMetaData; /** provides access to the meta data of a result set. - <p>The number, types, and properties of a ResultSet's columns are - provided by the ResultSetMetaData object returned by the getMetaData - method.</p> + <p> + The number, types, and properties of a ResultSet's columns are + provided by the + <type scope="com::sun::star::sdbc">ResultSetMetaData</type> + object returned by the + <member scope="com::sun::star::sdbc">XResultSetMetaDataSupplier::getMetaData()</member> + method. + </p> */ interface XResultSetMetaDataSupplier: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaDataSupplier::getMetaData /** retrieves the number, types, and properties of a ResultSet's columns. + @returns + the meta data of the ResultSet. + @throws SQLException + if a database access error occurs. */ XResultSetMetaData getMetaData() raises (SQLException); }; @@ -97,6 +106,12 @@ interface XResultSetMetaDataSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XResultSetUpdate.idl b/offapi/com/sun/star/sdbc/XResultSetUpdate.idl index 9fad57c602e2..16967b5cb5fa 100644 --- a/offapi/com/sun/star/sdbc/XResultSetUpdate.idl +++ b/offapi/com/sun/star/sdbc/XResultSetUpdate.idl @@ -2,9 +2,9 @@ * * $RCSfile: XResultSetUpdate.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,6 +83,8 @@ interface XResultSetUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::insertRow /** inserts the contents of the insert row into the result set and the database. Must be on the insert row when this method is called. + @throws SQLException + if a database access error occurs. */ void insertRow() raises (SQLException); //------------------------------------------------------------------------- @@ -90,6 +92,8 @@ interface XResultSetUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::updateRow /** updates the underlying database with the new contents of the current row. Cannot be called when on the insert row. + @throws SQLException + if a database access error occurs. */ void updateRow() raises (SQLException); //------------------------------------------------------------------------- @@ -97,6 +101,8 @@ interface XResultSetUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::deleteRow /** deletes the current row from the result set and the underlying database. Cannot be called when on the insert row. + @throws SQLException + if a database access error occurs. */ void deleteRow() raises (SQLException); //------------------------------------------------------------------------- @@ -105,12 +111,18 @@ interface XResultSetUpdate: com::sun::star::uno::XInterface /** cancels the updates made to a row. - <p>This method may be called after calling an - <code>updateXXX</code> method(s) and before calling <code>updateRow</code> + <p> + This method may be called after calling an + <code>updateXXX</code> + method(s) and before calling + <member scope="com::sun::star::sdbc">XResultSetUpdate::updateRow()</member> to rollback the updates made to a row. If no updates have been made or - <code>updateRow</code> has already been called, then this method has no + <code>updateRow</code> + has already been called, then this method has no effect. </p> + @throws SQLException + if a database access error occurs. */ void cancelRowUpdates() raises (SQLException); //------------------------------------------------------------------------- @@ -120,19 +132,35 @@ interface XResultSetUpdate: com::sun::star::uno::XInterface remembered while the cursor is positioned on the insert row. - <p> The insert row is a special row associated with an updatable + <p> + The insert row is a special row associated with an updatable result set. It is essentially a buffer where a new row may - be constructed by calling the <code>updateXXX</code> methods prior to + be constructed by calling the + <code>updateXXX</code> + methods prior to inserting the row into the result set. </p> - <p>Only the <code>updateXXX</code>, <code>getXXX</code>, - and <code>insertRow</code> methods may be + <p> + Only the + <code>updateXXX</code> + , + <code>getXXX</code> + , + and + <member scope="com::sun::star::sdbc">XResultSetUpdate::insertRow()</member> + methods may be called when the cursor is on the insert row. All of the columns in a result set must be given a value each time this method is - called before calling <code>insertRow</code>. - The method <code>updateXXX</code> must be called before a - <code>getXXX</code> method can be called on a column value. + called before calling + <code>insertRow</code> + . The method + <code>updateXXX</code> + must be called before a + <code>getXXX</code> + method can be called on a column value. </p> + @throws SQLException + if a database access error occurs. */ void moveToInsertRow() raises (SQLException); //------------------------------------------------------------------------- @@ -141,6 +169,8 @@ interface XResultSetUpdate: com::sun::star::uno::XInterface /** moves the cursor to the remembered cursor position, usually the current row. This method has no effect if the cursor is not on the insert row. + @throws SQLException + if a database access error occurs. */ void moveToCurrentRow() raises (SQLException); }; @@ -151,6 +181,12 @@ interface XResultSetUpdate: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XRow.idl b/offapi/com/sun/star/sdbc/XRow.idl index 08493625cd81..77e413d88b62 100644 --- a/offapi/com/sun/star/sdbc/XRow.idl +++ b/offapi/com/sun/star/sdbc/XRow.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRow.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -99,7 +99,9 @@ interface XClob; // DocMerge from xml: interface com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow /** is used to access data which is collected in a row. - All methods raise a SQLException if a database access error occurs. + All methods raise a + <type scope="com::sun::star::sdbc">SQLException</type> + if a database access error occurs. */ interface XRow: com::sun::star::uno::XInterface { @@ -110,54 +112,107 @@ interface XRow: com::sun::star::uno::XInterface Note that you must first call getXXX on a column to try to read its value and then call wasNull() to see if the value read was SQL NULL. + + @returns + <TRUE/> if last column read was SQL NULL and <FALSE/> otherwise + @throws SQLException + if a database access error occurs. */ boolean wasNull() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getString /** gets the value of a column in the current row as a string. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ string getString([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getBoolean /** gets the value of a column in the current row as boolean. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ boolean getBoolean([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getByte /** get the value of a column in the current row as a byte. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ byte getByte([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getShort /** gets the value of a column in the current row as a short. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ short getShort([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getInt /** get the value of a column in the current row as an integer. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ long getInt([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getLong /** get the value of a column in the current row as a long. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ hyper getLong([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getFloat /** gets the value of a column in the current row as a float. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ float getFloat([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getDouble /** gets the value of a column in the current row as a double. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ double getDouble([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- @@ -177,6 +232,12 @@ interface XRow: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getDate /** gets the value of a column in the current row as a date object. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ com::sun::star::util::Date getDate([in]long columnIndex) raises (SQLException); @@ -184,6 +245,12 @@ interface XRow: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getTime /** gets the value of a column in the current row as a time object. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ com::sun::star::util::Time getTime([in]long columnIndex) raises (SQLException); @@ -191,6 +258,12 @@ interface XRow: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getTimestamp /** gets the value of a column in the current row as a datetime object. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ com::sun::star::util::DateTime getTimestamp([in]long columnIndex) raises (SQLException); @@ -207,10 +280,17 @@ interface XRow: com::sun::star::uno::XInterface <b>Note:</b> All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream. Also, a - stream may return 0 when the method <code>available</code> + stream may return 0 when the method + <member scope="com::sun::star::io">XInputStream::available()</member> is called whether there is data available or not. </p> + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ com::sun::star::io::XInputStream getBinaryStream([in]long columnIndex) raises (SQLException); @@ -227,10 +307,17 @@ interface XRow: com::sun::star::uno::XInterface <b>Note:</b> All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream. Also, a - stream may return 0 when the method <code>available</code> + stream may return 0 when the method + <member scope="com::sun::star::io">XInputStream::available()</member> is called whether there is data available or not. </p> + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ com::sun::star::io::XInputStream getCharacterStream([in]long columnIndex) raises (SQLException); @@ -238,9 +325,18 @@ interface XRow: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getObject /** returns the value of a column in the current row as an object. - This method uses the given <code>Map</code> object - for the custom mapping of the SQL structure or distinct type + This method uses the given + <code>Map</code> + object for the custom mapping of the SQL structure or distinct type that is being retrieved. + @param columnIndex + the first column is 1, the second is 2, + @param typeMap + the map of types which should be used to get the column value + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ any getObject([in]long columnIndex, [in]com::sun::star::container::XNameAccess typeMap) @@ -249,24 +345,52 @@ interface XRow: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getRef /** gets a REF(&lt;structured-type&gt;) column value from the current row. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ XRef getRef([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getBlob /** gets a BLOB value in the current row. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ XBlob getBlob([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getClob - /** gets a CLOB value in the current row of this <code>ResultSet</code> object. + /** gets a CLOB value in the current row of this + <code>ResultSet</code> + object. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ XClob getClob([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getArray - /** gets a SQL ARRAY value from the current row of this <code>ResultSet</code> object. + /** gets a SQL ARRAY value from the current row of this + <code>ResultSet</code> + object. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ XArray getArray([in]long columnIndex) raises (SQLException); }; @@ -277,6 +401,12 @@ interface XRow: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.6.2.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.6 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.5 2001/10/16 06:40:03 oj #76791# documentation added diff --git a/offapi/com/sun/star/sdbc/XRowSet.idl b/offapi/com/sun/star/sdbc/XRowSet.idl index 4a483e460bae..8b2199b152e1 100644 --- a/offapi/com/sun/star/sdbc/XRowSet.idl +++ b/offapi/com/sun/star/sdbc/XRowSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRowSet.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,9 +78,11 @@ interface XConnection; - <p>The XRowSet interface is unique in that it is intended to be + <p> + The XRowSet interface is unique in that it is intended to be a software layer on top of an SDBC driver. Implementations of the - RowSet interface can be provided by anyone.</p> + RowSet interface can be provided by anyone. + </p> */ interface XRowSet: XResultSet { @@ -89,6 +91,9 @@ interface XRowSet: XResultSet // DocMerge from xml: method com::sun::star::sdbc::XRowSet::execute /** populates a row set with data. The description of the data source and other important information for filling the row set with data. + + @throws SQLException + if a database access error occurs. */ void execute() raises (SQLException); //------------------------------------------------------------------------- @@ -96,12 +101,16 @@ interface XRowSet: XResultSet // DocMerge from xml: method com::sun::star::sdbc::XRowSet::addRowSetListener /** adds the specified listener to receive the events "cursorMoved", "rowChanged", and "rowSetChanged". + @param listener + the listener which should be registered */ [oneway] void addRowSetListener([in]XRowSetListener listener ); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XRowSet::removeRowSetListener /** removes the specified listener. + @param listener + the listener which should be registered */ [oneway] void removeRowSetListener([in]XRowSetListener listener ); }; @@ -112,6 +121,12 @@ interface XRowSet: XResultSet /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XRowSetListener.idl b/offapi/com/sun/star/sdbc/XRowSetListener.idl index 097029184cfa..8b28d0288c26 100644 --- a/offapi/com/sun/star/sdbc/XRowSetListener.idl +++ b/offapi/com/sun/star/sdbc/XRowSetListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRowSetListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,12 +77,16 @@ interface XRowSetListener: com::sun::star::lang::XEventListener // DocMerge from xml: method com::sun::star::sdbc::XRowSetListener::cursorMoved /** is called when a rowset's cursor is moved. + @param event + contains information about the event */ [oneway] void cursorMoved([in]com::sun::star::lang::EventObject event); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XRowSetListener::rowChanged /** is called when a row is inserted, updated, or deleted. + @param event + contains information about the event */ [oneway] void rowChanged([in]com::sun::star::lang::EventObject event); //------------------------------------------------------------------------- @@ -90,6 +94,8 @@ interface XRowSetListener: com::sun::star::lang::XEventListener // DocMerge from xml: method com::sun::star::sdbc::XRowSetListener::rowSetChanged /** is called when the row set has changed, or in other words, when the row set has been reexecuted. + @param event + contains information about the event */ [oneway] void rowSetChanged([in]com::sun::star::lang::EventObject event); }; @@ -100,6 +106,12 @@ interface XRowSetListener: com::sun::star::lang::XEventListener /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XRowUpdate.idl b/offapi/com/sun/star/sdbc/XRowUpdate.idl index 9990097072d2..fcb797b55f6c 100644 --- a/offapi/com/sun/star/sdbc/XRowUpdate.idl +++ b/offapi/com/sun/star/sdbc/XRowUpdate.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRowUpdate.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -96,66 +96,130 @@ interface XRowUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateNull /** gives a nullable column a null value. + @param columnIndex + the position of the column + @throws SQLException + if a database access error occurs. */ void updateNull([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateBoolean /** updates a column with a boolean value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateBoolean([in]long columnIndex, [in]boolean x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateByte /** updates a column with a byte value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateByte([in]long columnIndex, [in]byte x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateShort /** updates a column with a short value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateShort([in]long columnIndex, [in]short x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateInt /** updates a column with an long value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateInt([in]long columnIndex, [in]long x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateLong /** updates a column with a hyper value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateLong([in]long columnIndex, [in]hyper x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateFloat /** updates a column with a float value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateFloat([in]long columnIndex, [in]float x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateDouble /** updates a column with a double value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateDouble([in]long columnIndex, [in]double x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateString /** updates a column with a string value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateString([in]long columnIndex, [in]string x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateBytes /** updates a column with a byte array value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateBytes([in]long columnIndex, [in]sequence<byte> x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateDate /** updates a column with a date value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateDate([in]long columnIndex, [in]com::sun::star::util::Date x) raises (SQLException); @@ -163,6 +227,12 @@ interface XRowUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateTime /** updates a column with a time value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateTime([in]long columnIndex, [in]com::sun::star::util::Time x) raises (SQLException); @@ -170,6 +240,12 @@ interface XRowUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateTimestamp /** updates a column with a timestamp value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateTimestamp([in]long columnIndex, [in]com::sun::star::util::DateTime x) @@ -178,6 +254,14 @@ interface XRowUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateBinaryStream /** updates a column with a stream value. + @param columnIndex + the position of the column + @param x + the new column value + @param length + how much data should be read out of the stream + @throws SQLException + if a database access error occurs. */ void updateBinaryStream([in]long columnIndex, [in]com::sun::star::io::XInputStream x, @@ -186,6 +270,14 @@ interface XRowUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateCharacterStream /** updates a column with a stream value. + @param columnIndex + the position of the column + @param x + the new column value + @param length + how much data should be read out of the stream + @throws SQLException + if a database access error occurs. */ void updateCharacterStream([in]long columnIndex, [in]com::sun::star::io::XInputStream x, @@ -194,6 +286,12 @@ interface XRowUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateObject /** updates a column with an object value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateObject([in]long columnIndex, [in]any x) raises (SQLException); @@ -201,6 +299,14 @@ interface XRowUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateNumericObject /** updates a column with an object value. + @param columnIndex + the position of the column + @param x + the new column value + @param scale + defines the scale which should be used to write the numeric value + @throws SQLException + if a database access error occurs. */ void updateNumericObject([in]long columnIndex, [in]any x, [in]long scale) raises (SQLException); @@ -212,6 +318,12 @@ interface XRowUpdate: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XSQLData.idl b/offapi/com/sun/star/sdbc/XSQLData.idl index ef3a8cc855ed..01194a5c99ae 100644 --- a/offapi/com/sun/star/sdbc/XSQLData.idl +++ b/offapi/com/sun/star/sdbc/XSQLData.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSQLData.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:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,7 +84,8 @@ interface XSQLOutput; registered in a type mapping. It is expected that this interface will normally be implemented by a tool. The methods in this interface are called by the driver and are never called by a programmer - directly.</p> + directly. + </p> */ interface XSQLData: com::sun::star::uno::XInterface { @@ -94,9 +95,14 @@ interface XSQLData: com::sun::star::uno::XInterface that this object represents. - <p>This method is called by the SDBC driver to get the name of the + <p> + This method is called by the SDBC driver to get the name of the UDT instance that is being mapped to this instance of SQLData. </p> + @returns + the name of the SQL type. + @throws SQLException + if a database access error occurs. */ string getSQLTypeName() raises (SQLException); @@ -106,23 +112,39 @@ interface XSQLData: com::sun::star::uno::XInterface /** populates this object with data read from the database. - <p>The implementation of the method must follow this protocol:<br> + <p> + The implementation of the method must follow this protocol: + <br/> It must read each of the attributes or elements of the SQL type from the given input stream. This is done by calling a method of the input stream to read each item, in the order that they appear in the SQL definition - of the type. The method <code>readSQL</code> then - assigns the data to appropriate fields or elements (of this - or other objects).<br> - Specifically, it must call the appropriate <code>XSQLInput.readXXX</code> + of the type. The method + <code>readSQL</code> + then assigns the data to appropriate fields or elements (of this + or other objects). + <br/> + Specifically, it must call the appropriate + <code>XSQLInput.readXXX</code> method(s) to do the following: for a Distinct Type, read its single data element; for a Structured Type, read a value for each attribute of the SQL type. </p> - <p> The SDBC driver initializes the input stream with a type map + <p> + The SDBC driver initializes the input stream with a type map before calling this method, which is used by the appropriate - <code>SQLInput.readXXX</code> method on the stream. - </p>@see com::sun::star::sdbc::XSQLInput + <code>SQLInput.readXXX</code> + method on the stream. + </p> + + @param stream + the input SQL data stream + @param typeName + the SQL type of the value on the data stream + @throws SQLException + if a database access error occurs. + + @see com::sun::star::sdbc::XSQLInput */ void readSQL([in]XSQLInput stream, [in]string typeName) raises (SQLException); @@ -132,15 +154,23 @@ interface XSQLData: com::sun::star::uno::XInterface /** writes this object to the given SQL data stream. - <p>The implementation of the method must follow this protocol:<br> + <p> + The implementation of the method must follow this protocol: + <br/> It must write each of the attributes of the SQL type to the given output stream. This is done by calling a method of the output stream to write each item, in the order that they appear in the SQL definition of the type. - Specifically, it must call the appropriate <code>XSQLOutput.writeXXX</code> + Specifically, it must call the appropriate + <code>XSQLOutput.writeXXX</code> method(s) to do the following:<br> for a Distinct Type, write its single data element; for a Structured Type, write a value for each attribute of the SQL type. - </p>@see com::sun::star::sdbc::XSQLOutput + </p> + @param stream + the output SQL data stream + @throws SQLException + if a database access error occurs. + @see com::sun::star::sdbc::XSQLOutput */ void writeSQL([in]XSQLOutput stream) raises (SQLException); }; @@ -151,6 +181,12 @@ interface XSQLData: 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 diff --git a/offapi/com/sun/star/sdbc/XSQLInput.idl b/offapi/com/sun/star/sdbc/XSQLInput.idl index 55ceb20feb12..2cc680d5478f 100644 --- a/offapi/com/sun/star/sdbc/XSQLInput.idl +++ b/offapi/com/sun/star/sdbc/XSQLInput.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSQLInput.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -98,105 +98,170 @@ interface XClob; instance of a SQL structured or distinct type. - <p>This interface, used only for custom mapping, is used by the driver + <p> + This interface, used only for custom mapping, is used by the driver behind the scenes, and a programmer never directly invokes - <code>SQLInput</code> methods. + <code>SQLInput</code> + methods. </p> - <p>When the method <code>getObject</code> is called with an - object of a service implementing the interface <code>SQLData</code>, - the SDBC driver calls the method <code>XSQLData.getSQLType</code> + <p> + When the method + <code>getObject</code> + is called with an object of a service implementing the interface + <code>SQLData</code> + , the SDBC driver calls the method + <member scope="com::sun::star::sdbc">XSQLData::getSQLType()</member> to determine the SQL type of the user-defined type (UDT) being custom mapped. - The driver creates an instance of <code>XSQLInput</code>, + The driver creates an instance of + <type scope="com::sun::star::sdbc">XSQLInput</type> + , populating it with the attributes of the UDT. The driver then passes the input - stream to the method <code>XSQLData.readSQL</code>, which in turn - calls the <code>XSQLInput.readXXX</code> methods in its implementation for - reading the attributes from the input stream.</p> + stream to the method + <member scope="com::sun::star::sdbc">XSQLData::readSQL()</member> + , which in turn calls the + <code>XSQLInput.readXXX</code> + methods in its implementation for reading the attributes from the input stream. + </p> */ interface XSQLInput: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readString /** reads the next attribute in the stream as string. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ string readString() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readBoolean /** reads the next attribute in the stream as boolean. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ boolean readBoolean() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readByte /** reads the next attribute in the stream as byte. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ byte readByte() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readShort /** reads the next attribute in the stream as short. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ short readShort() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readInt /** reads the next attribute in the stream as long. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ long readInt() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readLong /** reads the next attribute in the stream as hyper. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ hyper readLong() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readFloat /** reads the next attribute in the stream as float. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ float readFloat() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readDouble /** reads the next attribute in the stream as double. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ double readDouble() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from idl: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readBytes /** reads the next attribute in the stream as sequence of bytes. - @throws SQLException - if a database access error occurs + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ sequence<byte> readBytes() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readDate /** reads the next attribute in the stream as date. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ com::sun::star::util::Date readDate() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readTime /** reads the next attribute in the stream as time. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ com::sun::star::util::Time readTime() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readTimestamp /** reads the next attribute in the stream as datetime. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ com::sun::star::util::DateTime readTimestamp() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readBinaryStream /** reads the next attribute in the stream as sequence of bytes. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ com::sun::star::io::XInputStream readBinaryStream() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readCharacterStream /** reads the next attribute in the stream as a unicode string. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ com::sun::star::io::XInputStream readCharacterStream() raises (SQLException); //------------------------------------------------------------------------- @@ -205,50 +270,78 @@ interface XSQLInput: com::sun::star::uno::XInterface /** returns the datum at the head of the stream as an any. - <p>The actual type of the any returned is determined by the default + <p> + The actual type of the any returned is determined by the default type mapping, and any customizations present in this stream's type map. - <br>A type map is registered with the stream by the SDBC driver before the + <br/> + A type map is registered with the stream by the SDBC driver before the stream is passed to the application. - <br>When the datum at the head of the stream is a SQL NULL, + <br/> + When the datum at the head of the stream is a SQL NULL, the method returns <void/>. If the datum is a SQL structured or distinct type, it determines the SQL type of the datum at the head of the stream, constructs an object of the appropriate service, and calls the method - <code>XSQLData.readSQL</code> on that object, which reads additional data + <member scope="com::sun::star::sdbc">XSQLData::readSQL()</member> + on that object, which reads additional data from the stream using the protocol described for that method. </p> + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ any readObject() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readRef /** reads a REF(&lt;structured-type&gt;) from the stream. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ XRef readRef() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readBlob /** reads a BLOB from the stream. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ XBlob readBlob() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readClob /** reads a CLOB from the stream. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ XClob readClob() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readArray /** reads an array from the stream. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ XArray readArray() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::wasNull /** determines whether the last value read was null. + @returns + <TRUE/> if the most recently gotten SQL value was null; otherwise, <FALSE/> + @throws SQLException + if a database access error occurs. */ boolean wasNull() raises (SQLException); }; @@ -259,6 +352,12 @@ interface XSQLInput: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.6.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.6 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.5 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XSQLOutput.idl b/offapi/com/sun/star/sdbc/XSQLOutput.idl index d9609b315a8b..f34fe44a11e8 100644 --- a/offapi/com/sun/star/sdbc/XSQLOutput.idl +++ b/offapi/com/sun/star/sdbc/XSQLOutput.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSQLOutput.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -102,89 +102,146 @@ interface XSQLData; by a programmer. - <p>When an object of a class implementing interface <code>XSQLData</code> is - passed as an argument to a SQL statement, the JDBC driver calls - <code>SQLData.getSQLType</code> to determine the kind of SQL datum being - passed to the database. - <br>The driver then creates an instance of <code>XSQLOutput</code> and - passes it to the method <code>SQLData.writeSQL</code>. - The method <code>writeSQL</code> in turn calls the - appropriate <code>SQLOutput.writeXXX</code> methods - to write data from the <code>SQLData</code> object to - the <code>SQLOutput</code> output stream as the - representation of a SQL user-defined type.</p> + <p> + When an object of a class implementing interface + <type scope="com::sun::star::sdbc">XSQLData</type> + is passed as an argument to a SQL statement, the JDBC driver calls + <member scope="com::sun::star::sdbc">SQLData::getSQLType()</member> + to determine the kind of SQL datum being passed to the database. + <br/> + The driver then creates an instance of + <code>XSQLOutput</code> + and passes it to the method + <member scope="com::sun::star::sdbc">XSQLData::writeSQL()</member> + . The method + <code>writeSQL</code> + in turn calls the appropriate + <code>XSQLOutput.writeXXX</code> + methods to write data from the + <type scope="com::sun::star::sdbc">XSQLData</type> + object to the + <code>XSQLOutput</code> + output stream as the representation of a SQL user-defined type.</p> */ interface XSQLOutput: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeString /** writes the next attribute to the stream as a string. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeString([in]string x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeBoolean /** writes the next attribute to the stream as boolean. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeBoolean([in]boolean x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeByte /** writes the next attribute to the stream as byte. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeByte([in]byte x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeShort /** writes the next attribute to the stream as short. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeShort([in]short x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeInt /** writes the next attribute to the stream as long. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeInt([in]long x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeLong /** writes the next attribute to the stream as hyper. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeLong([in]hyper x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeFloat /** writes the next attribute to the stream as float. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeFloat([in]float x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeDouble /** writes the next attribute to the stream as double. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeDouble([in]double x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeBytes /** writes the next attribute to the stream as byte sequence. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeBytes([in]sequence<byte> x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeDate /** writes the next attribute to the stream as a date. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeDate([in]com::sun::star::util::Date x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeTime /** writes the next attribute to the stream as a time. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeTime([in]com::sun::star::util::Time x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeTimestamp /** writes the next attribute to the stream as a datetime. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeTimestamp([in]com::sun::star::util::DateTime x) raises (SQLException); @@ -193,6 +250,10 @@ interface XSQLOutput: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeBinaryStream /** writes the next attribute to the stream as a stream of uninterpreted bytes. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeBinaryStream([in]com::sun::star::io::XInputStream x) raises (SQLException); @@ -200,6 +261,10 @@ interface XSQLOutput: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeCharacterStream /** writes the next attribute to the stream as a stream of unicode string. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeCharacterStream([in]com::sun::star::io::XInputStream x) raises (SQLException); @@ -210,49 +275,83 @@ interface XSQLOutput: com::sun::star::uno::XInterface <code>XSQLData</code> object. - <p>When the <code>XSQLData</code> object is <NULL/>, this - method writes an SQL NULL to the stream. - Otherwise, it calls the <code>SQLData.writeSQL</code> + <p + >When the + <code>XSQLData</code> + object is + <NULL/> + , this method writes an SQL NULL to the stream. + Otherwise, it calls the + <member scope="com::sun::star::sdbc">XSQLData::writeSQL()</member> method of the given object, which writes the object's attributes to the stream. - The implementation of the method <code>XSQLData.writeSQL</code> - calls the appropriate <code>XSQLOutput.writeXXX</code> method(s) - for writing each of the object's attributes in order. - <br>The attributes must be read from an <code>XSQLInput</code> - input stream and written to an <code>XSQLOutput</code> + The implementation of the method + <code>XSQLData::writeSQL()</code> + calls the appropriate + <code>XSQLOutput.writeXXX</code> + method(s) for writing each of the object's attributes in order. + <br/> + The attributes must be read from an + <type scope="com::sun::star::sdbc">XSQLInput</type> + input stream and written to an + <code>XSQLOutput</code> output stream in the same order in which they were listed in the SQL definition of the user-defined type. </p> + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeObject([in]XSQLData x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeRef /** writes a REF(&lt;structured-type&gt;) to the stream. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeRef([in]XRef x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeBlob /** writes a BLOB to the stream. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeBlob([in]XBlob x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeClob /** writes a CLOB to the stream. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeClob([in]XClob x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeStruct /** writes a structured-type to the stream. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeStruct([in]XStruct x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeArray /** writes an array to the stream. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeArray([in]XArray x) raises (SQLException); }; @@ -263,6 +362,12 @@ interface XSQLOutput: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/19 13:46:04 mi syntax errors in documentation fixed diff --git a/offapi/com/sun/star/sdbc/XStatement.idl b/offapi/com/sun/star/sdbc/XStatement.idl index 5094f6ad7524..5e975a305a74 100644 --- a/offapi/com/sun/star/sdbc/XStatement.idl +++ b/offapi/com/sun/star/sdbc/XStatement.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStatement.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,17 +81,27 @@ interface XResultSet; - <p>Only one ResultSet per Statement can be open at any point in + <p> + Only one ResultSet per Statement can be open at any point in time; therefore, if the reading of one ResultSet is interleaved with the reading of another, each must have been generated by - different Statements. All statement <code>execute</code> methods implicitly - close a statement's current ResultSet if an open one exists.</p> + different Statements. All statement + <code>execute</code> + methods implicitly + close a statement's current ResultSet if an open one exists. + </p> */ interface XStatement: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::XStatement::executeQuery /** executes a SQL statement that returns a single ResultSet. + @param sql + the SQL statement which should be executed + @returns + a ResultSet that contains the data produced by the query; never <NULL/> + @throws SQLException + if a database access error occurs. */ XResultSet executeQuery([in]string sql) raises (SQLException); //------------------------------------------------------------------------- @@ -100,6 +110,13 @@ interface XStatement: com::sun::star::uno::XInterface /** executes an SQL INSERT, UPDATE, or DELETE statement. In addition, SQL statements that return nothing, such as SQL DDL statements, can be executed. + + @param sql + a SQL INSERT, UPDATE or DELETE statement or a SQL statement that returns nothing + @returns + either the row count for INSERT, UPDATE or DELETE or 0 for SQL statements that return nothing + @throws SQLException + if a database access error occurs. */ long executeUpdate([in]string sql) raises (SQLException); //------------------------------------------------------------------------- @@ -108,25 +125,49 @@ interface XStatement: com::sun::star::uno::XInterface /** executes a SQL statement that may return multiple results. - <p>Under some (uncommon) situations a single SQL statement may return + <p> + Under some (uncommon) situations a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string. The navigation through multiple results is covered by <type scope="com::sun::star::sdbc">XMultipleResults</type>. </p> - <p>The <code>execute</code> method executes a SQL statement and indicates - the form of the first result. You can then use <code>getResultSet</code> or - <code>getUpdateCount</code> to retrieve the result, and - <code>getMoreResults</code> to move to any subsequent result(s). + <p> + The + <code>execute</code> + method executes a SQL statement and indicates + the form of the first result. You can then use + <member scope="com::sun::star::sdbc">XStatement::getResultSet()</member> + or + <member scope="com::sun::star::sdbc">XStatement::getUpdateCount()</member> + to retrieve the result, and + <member scope="com::sun::star::sdbc">XStatement::getMoreResults()</member> + to move to any subsequent result(s). </p> + + @param sql + any SQL statement + @returns + <TRUE/> if the next result is a ResultSet; <FALSE/> if it is an update count or there are no more results + @throws SQLException + if a database access error occurs. */ boolean execute([in]string sql) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XStatement::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 + <code>Statement</code> + object. + @returns + the connection that produced this statement + + @throws SQLException + if a database access error occurs. */ XConnection getConnection() raises (SQLException); }; @@ -137,6 +178,12 @@ interface XStatement: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XStruct.idl b/offapi/com/sun/star/sdbc/XStruct.idl index 1f9c527c6dc6..5f652d769613 100644 --- a/offapi/com/sun/star/sdbc/XStruct.idl +++ b/offapi/com/sun/star/sdbc/XStruct.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStruct.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:06 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,17 +80,29 @@ interface XNameAccess; /** is used for the standard mapping for a SQL structured type. - <p>A <code>Struct</code> object contains a value for each attribute + <p> + A + <code>Struct</code> + object contains a value for each attribute of the SQL structured type that it represents. - By default, an instance of <code>Struct</code> is valid as long as the - application has a reference to it.</p> + By default, an instance of + <code>Struct</code> + is valid as long as the + application has a reference to it. + </p> */ interface XStruct: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XStruct::getSQLTypeName /** retrieves the SQL type name of the SQL structured type - that this <code>Struct</code> object represents. + that this + <code>Struct</code> + object represents. + @returns + the name of the SQL type. + @throws SQLException + if a database access error occurs. */ string getSQLTypeName() raises (SQLException); @@ -98,15 +110,24 @@ interface XStruct: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::container::com::sun::star::sdbc::XStruct::getAttributes /** produces the ordered values of the attributes of the SQL - structured type that this <code>Struct</code> object represents. - <p>This method uses the given type map for customizations of the type + structured type that this + <code>Struct</code> + object represents. + <p> + This method uses the given type map for customizations of the type mappings. If there is no entry in the given type map that matches or - the given type map is <NULL/>, the structured type that this - <code>Struct</code> object represents, the driver uses + the given type map is + <NULL/> + , the structured type that this + <code>Struct</code> + object represents, the driver uses the connection type mapping. @param typeMap is a map object that contains mappings of SQL type names to - services. If the <code>typeMap</code> is <NULL/>, the type-map + services. If the + <code>typeMap</code>is + <NULL/> + , the type-map associated with the connection for customizations of the type-mappings is used. @returns @@ -124,6 +145,12 @@ interface XStruct: 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 diff --git a/offapi/com/sun/star/sdbc/XWarningsSupplier.idl b/offapi/com/sun/star/sdbc/XWarningsSupplier.idl index dc6380e3690c..e5cf1d18c939 100644 --- a/offapi/com/sun/star/sdbc/XWarningsSupplier.idl +++ b/offapi/com/sun/star/sdbc/XWarningsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XWarningsSupplier.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:06 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,7 +74,8 @@ // DocMerge from xml: interface com::sun::star::sdbc::XWarningsSupplier /** should be implemented of objects which may report warnings or non critical - errors .@see com::sun::star::sdbc::SQLWarning + errors. + @see com::sun::star::sdbc::SQLWarning */ interface XWarningsSupplier: com::sun::star::uno::XInterface { @@ -84,13 +85,15 @@ interface XWarningsSupplier: com::sun::star::uno::XInterface /** returns the first warning reported by calls on an object that supports the usage of warnings. - - <p> <b>Note:</b> Subsequent warnings will be chained to this - SQLWarning. - + <type scope="com::sun::star::sdbc">SQLWarning</type> + . </p> + @returns + the warnings + @throws SQLException + if a database access error occurs. */ any getWarnings() raises (SQLException); @@ -98,9 +101,13 @@ interface XWarningsSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XWarningsSupplier::clearWarnings /** clears all warnings reported for the object implementing the interface. - After a call to this method, the method <code>getWarnings</code> - returns <void/> until a new warning is - reported for the object. + After a call to this method, the method + <member scope="com::sun::star::sdbc">XWarningsSupplier::getWarnings()</member> + returns + <void/> + until a new warning is reported for the object. + @throws SQLException + if a database access error occurs. */ void clearWarnings() raises (SQLException); }; @@ -111,6 +118,12 @@ interface XWarningsSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.6.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.6 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.5 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions |