diff options
Diffstat (limited to 'offapi/com/sun/star/sdb/RowSet.idl')
| -rw-r--r-- | offapi/com/sun/star/sdb/RowSet.idl | 75 |
1 files changed, 54 insertions, 21 deletions
diff --git a/offapi/com/sun/star/sdb/RowSet.idl b/offapi/com/sun/star/sdb/RowSet.idl index 37dea25a0..136641d00 100644 --- a/offapi/com/sun/star/sdb/RowSet.idl +++ b/offapi/com/sun/star/sdb/RowSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: RowSet.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,6 +73,10 @@ interface XConnection; #include <com/sun/star/sdb/ResultSet.idl> #endif +#ifndef __com_sun_star_sdb_XCompletedExecution_idl__ +#include <com/sun/star/sdb/XCompletedExecution.idl> +#endif + module com { module sun { module star { module sdbcx { interface XDeleteRows; };};};}; @@ -80,7 +84,6 @@ interface XDeleteRows; module com { module sun { module star { module sdb { interface XRowSetApproveBroadcaster; -interface XParametersSupplier; interface XResultSetAccess; @@ -89,19 +92,18 @@ interface XResultSetAccess; a query or a SQL command or by a rowset reader, who mustn't support SQL. The connection of the rowset is typically a named DataSource or a DataAccess component or a previous instanciated connection. -<!-- JRH: Trial text below, is this what is intended? No changes to above text. - - is a client side RowSet, use of which retrieves data, based on a database table, - a query or a SQL command or by a rowset reader, which must not support SQL. - The connection of the rowset is typically a named DataSource, a DataAccess component, - or a previous instanciated connection. - --> - <p>Depending on the ResultSetConcurrency, the RowSet caches all data or uses + <p> + Depending on the + <type scope="com::sun::star::sdbc">ResultSetConcurrency</type> + , the RowSet caches all data or uses an optimized way for retrieving the data, such as, refetching rows by their keys or if provided, by their bookmarks. </p> - <p>In addition, it provides events for RowSet navigation and RowSet modifications + <p> + In addition, it provides events for RowSet navigation and RowSet modifications to approve the actions and to react on them. + @see com::sun::star::sdb::RowChangeAction + @see com::sun::star::sdb::RowChangeEvent </p> */ service RowSet @@ -113,7 +115,18 @@ service RowSet service com::sun::star::sdb::ResultSet; - // DocMerge from xml: service com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::RowSet: interface com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::XRowSetApproveBroadcaster + /** can be used to allow an interaction handler to supply missing data during a execute process. + + <p>If you want a row set to be based on a parametrized query, you will usually use + the <type scope="com::sun::star::sdbc">XParameters</type> interface.<br/> + However, you can also choose to let an interaction handler supply such data. For this, you may + for instance instantiate an <type>InteractionHandler</type>, which asks the user for the + data, or you may write your own one, which supplies the data from somewhere else.</p> + + @see com::sun::star::sdb::InteractionHandler + */ + interface com::sun::star::sdb::XCompletedExecution; + /** approving of actions performed on the rowset. */ interface XRowSetApproveBroadcaster; @@ -121,16 +134,22 @@ service RowSet // DocMerge from xml: service com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::RowSet: interface com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::XResultSetAccess /** creates a second result set which is based on the same data. - <p>The new result set is interoperable with the row set which created it, - e.g., you can exchange bookmarks between both sets.</p> - <p>If the row set is not alive (i.e., it was not executed before), <NULL/> is returned.</p> + <p> + The new result set is interoperable with the row set which created it, + e.g., you can exchange bookmarks between both sets. + </p> + <p> + If the row set is not alive (i.e., it was not executed before), + <NULL/> + is returned. + </p> */ interface XResultSetAccess; // DocMerge from xml: property com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::RowSet::ActiveConnection /** is the connection generated by a DataSource or by a URL. It could - also be set from outside. + also be set from outside. When set from outside the RowSet is not responsible for the closing of the connection. */ [property] com::sun::star::sdbc::XConnection ActiveConnection; @@ -144,19 +163,23 @@ service RowSet // DocMerge from xml: property com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::RowSet::Command /** is the command which should be executed, the type of command depends - on the CommandType.@see com::sun::star::sdb::CommandType + on the CommandType. + @see com::sun::star::sdb::CommandType */ [property] string Command; // DocMerge from xml: property com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::RowSet::CommandType - /** is the type of the command@see com::sun::star::sdb::CommandType.@see com::sun::star::sdb::CommandType. + /** is the type of the command. + @see com::sun::star::sdb::CommandType + @see com::sun::star::sdb::CommandType */ [property] long CommandType; // DocMerge from xml: property com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::RowSet::ActiveCommand - /** is the command which is currently used.@see com::sun::star::sdb::CommandType + /** is the command which is currently used. + @see com::sun::star::sdb::CommandType */ [readonly, property] string ActiveCommand; @@ -187,7 +210,8 @@ service RowSet // DocMerge from xml: property com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::RowSet::Privileges - /** indicates the privileges for insert, update, and delete.@see com::sun::star::sdbcx::Privilege + /** indicates the privileges for insert, update, and delete. + @see com::sun::star::sdbcx::Privilege */ [readonly, property] long Privileges; @@ -246,6 +270,15 @@ service RowSet /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.7.2.2 2002/08/05 13:01:36 fs + added XCompletedExecution + + Revision 1.7.2.1 2002/02/18 10:23:56 oj + #97563# parameter,return value and exception description + + Revision 1.7 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.6 2001/01/24 09:56:11 fs #83074# extended the doc for the XResultSetAccess interface |