summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdb
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/sdb')
-rw-r--r--offapi/com/sun/star/sdb/CallableStatement.idl16
-rw-r--r--offapi/com/sun/star/sdb/ColumnSettings.idl55
-rw-r--r--offapi/com/sun/star/sdb/Connection.idl17
-rw-r--r--offapi/com/sun/star/sdb/ContentLoader.idl56
-rw-r--r--offapi/com/sun/star/sdb/DataColumn.idl18
-rw-r--r--offapi/com/sun/star/sdb/DataSettings.idl20
-rw-r--r--offapi/com/sun/star/sdb/DataSource.idl94
-rw-r--r--offapi/com/sun/star/sdb/DataSourceBrowser.idl236
-rw-r--r--offapi/com/sun/star/sdb/DatabaseAccess.idl24
-rw-r--r--offapi/com/sun/star/sdb/DatabaseAccessConnection.idl39
-rw-r--r--offapi/com/sun/star/sdb/DatabaseAccessContext.idl13
-rw-r--r--offapi/com/sun/star/sdb/DatabaseAccessDataSource.idl19
-rw-r--r--offapi/com/sun/star/sdb/DatabaseContext.idl35
-rw-r--r--offapi/com/sun/star/sdb/DatabaseDocument.idl30
-rw-r--r--offapi/com/sun/star/sdb/DatabaseEnvironment.idl13
-rw-r--r--offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl78
-rw-r--r--offapi/com/sun/star/sdb/DefinitionContainer.idl38
-rw-r--r--offapi/com/sun/star/sdb/DocumentDefinition.idl14
-rw-r--r--offapi/com/sun/star/sdb/ErrorMessageDialog.idl109
-rw-r--r--offapi/com/sun/star/sdb/InteractionHandler.idl61
-rw-r--r--offapi/com/sun/star/sdb/ParametersRequest.idl28
-rw-r--r--offapi/com/sun/star/sdb/PreparedStatement.idl14
-rw-r--r--offapi/com/sun/star/sdb/Query.idl21
-rw-r--r--offapi/com/sun/star/sdb/QueryDefinition.idl16
-rw-r--r--offapi/com/sun/star/sdb/QueryDescriptor.idl20
-rw-r--r--offapi/com/sun/star/sdb/ResultColumn.idl13
-rw-r--r--offapi/com/sun/star/sdb/ResultSet.idl14
-rw-r--r--offapi/com/sun/star/sdb/RowChangeEvent.idl13
-rw-r--r--offapi/com/sun/star/sdb/RowSet.idl75
-rw-r--r--offapi/com/sun/star/sdb/RowSetVetoException.idl11
-rw-r--r--offapi/com/sun/star/sdb/SQLContext.idl17
-rw-r--r--offapi/com/sun/star/sdb/SQLQueryComposer.idl18
-rw-r--r--offapi/com/sun/star/sdb/Table.idl18
-rw-r--r--offapi/com/sun/star/sdb/TableDescriptor.idl15
-rw-r--r--offapi/com/sun/star/sdb/XAlterQuery.idl18
-rw-r--r--offapi/com/sun/star/sdb/XBookmarksSupplier.idl18
-rw-r--r--offapi/com/sun/star/sdb/XColumn.idl111
-rw-r--r--offapi/com/sun/star/sdb/XColumnUpdate.idl84
-rw-r--r--offapi/com/sun/star/sdb/XCommandPreparation.idl33
-rw-r--r--offapi/com/sun/star/sdb/XCompletedConnection.idl16
-rw-r--r--offapi/com/sun/star/sdb/XCompletedExecution.idl14
-rw-r--r--offapi/com/sun/star/sdb/XDatabaseAccess.idl29
-rw-r--r--offapi/com/sun/star/sdb/XDatabaseAccessListener.idl28
-rw-r--r--offapi/com/sun/star/sdb/XDatabaseEnvironment.idl22
-rw-r--r--offapi/com/sun/star/sdb/XFormDocumentsSupplier.idl12
-rw-r--r--offapi/com/sun/star/sdb/XInteractionSupplyParameters.idl18
-rw-r--r--offapi/com/sun/star/sdb/XParametersSupplier.idl12
-rw-r--r--offapi/com/sun/star/sdb/XQueriesSupplier.idl12
-rw-r--r--offapi/com/sun/star/sdb/XQueryDefinitionsSupplier.idl12
-rw-r--r--offapi/com/sun/star/sdb/XReportDocumentsSupplier.idl12
-rw-r--r--offapi/com/sun/star/sdb/XResultSetAccess.idl20
-rw-r--r--offapi/com/sun/star/sdb/XRowSetApproveBroadcaster.idl12
-rw-r--r--offapi/com/sun/star/sdb/XRowSetApproveListener.idl22
-rw-r--r--offapi/com/sun/star/sdb/XRowSetSupplier.idl14
-rw-r--r--offapi/com/sun/star/sdb/XSQLErrorBroadcaster.idl17
-rw-r--r--offapi/com/sun/star/sdb/XSQLErrorListener.idl15
-rw-r--r--offapi/com/sun/star/sdb/XSQLQueryComposer.idl75
-rw-r--r--offapi/com/sun/star/sdb/XSQLQueryComposerFactory.idl16
58 files changed, 1388 insertions, 532 deletions
diff --git a/offapi/com/sun/star/sdb/CallableStatement.idl b/offapi/com/sun/star/sdb/CallableStatement.idl
index e1f0cd7aa..da87ea13f 100644
--- a/offapi/com/sun/star/sdb/CallableStatement.idl
+++ b/offapi/com/sun/star/sdb/CallableStatement.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: CallableStatement.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:28 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -75,9 +75,9 @@
// DocMerge from xml: service com::sun::star::sdb::CallableStatement
/** represents a procedure call. The service differs only in the access
of the columns and parameters to the service
- <type scope="com::sun::star::sdbc">CallableStatement</type>.
-
-<!-- JRH: <type scope="com::sun::star::sdbc">CallableStatement</type> --> */
+ <type scope="com::sun::star::sdbc">CallableStatement</type>
+ .
+*/
service CallableStatement
{
// DocMerge: empty anyway
@@ -93,6 +93,12 @@ service CallableStatement
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.2.1 2002/02/18 10:27:10 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.3 2000/11/08 12:43:30 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/ColumnSettings.idl b/offapi/com/sun/star/sdb/ColumnSettings.idl
index 274460b64..3cc3a69cc 100644
--- a/offapi/com/sun/star/sdb/ColumnSettings.idl
+++ b/offapi/com/sun/star/sdb/ColumnSettings.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: ColumnSettings.idl,v $
*
- * $Revision: 1.8 $
+ * $Revision: 1.9 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:28 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -83,10 +83,12 @@ service ColumnSettings
interface.
</p>
<p>
- If the value is <void/>, a default numberformat should be used according
- to the datatype of the column.</p>
+ If the value is
+ <void/>
+ , a default numberformat should be used according to the datatype of the column.
+ </p>
-<!-- JRH: orig: <type scope="com::sun::star::util">XNumberFormatter</type> -->*/
+ */
[property] long FormatKey;
@@ -97,23 +99,34 @@ service ColumnSettings
1: center
2: right
</pre>
- <p> If the value is <void/>, a default alignment should be used according
- to the datatype of the column.</p>
+ <p>
+ If the value is
+ <void/>
+ , a default alignment should be used according
+ to the datatype of the column.
+ </p>
*/
[property] long Align;
/** specifies the width of the column displayed in a grid, the unit is 10THMM.
- <p> If the value is <void/>, a default width should be used according to the label
- of the column. </p>
+ <p>
+ If the value is
+ <void/>
+ , a default width should be used according to the label of the column.
+ </p>
*/
[property] long Width;
/** Position of the column within a grid.
- <p> If the value is <void/>, the default position should be taken according. </p>
+ <p>
+ If the value is
+ <void/>
+ , the default position should be taken according.
+ </p>
*/
[property] long Position;
@@ -124,14 +137,26 @@ service ColumnSettings
/** indicates a control model whichs defines the settings for layouting.
- The default is <NULL/>.
+ The default is
+ <NULL/>
+ .
*/
[optional, property] com::sun::star::beans::XPropertySet ControlModel;
/** describes an optional help text which can be used by UI components
- when representing this column.
+ when representing this column.
+ The default is
+ <NULL/>
+ .
*/
[optional, property] string HelpText;
+
+ /** describes the default value which should be displayed by a control when moving to a new row.
+ The default is
+ <NULL/>
+ .
+ */
+ [optional, property] string ControlDefault;
};
//=============================================================================
@@ -140,6 +165,12 @@ service ColumnSettings
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.8.2.1 2002/02/18 10:23:37 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.8 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.7 2001/09/24 11:21:17 fs
#65293#
diff --git a/offapi/com/sun/star/sdb/Connection.idl b/offapi/com/sun/star/sdb/Connection.idl
index 2101935de..e1ece215e 100644
--- a/offapi/com/sun/star/sdb/Connection.idl
+++ b/offapi/com/sun/star/sdb/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:30 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:28 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -81,8 +81,9 @@ interface XCommandPreparation;
// DocMerge from xml: service com::sun::star::sdb::Connection
-/** extends the connection of SDBC by providing the data definitions
- of a connected database.
+/** extends the
+ <type scope="com::sun::star::sdbc">connection</type>
+ of SDBC by providing the data definitions of a connected database.
*/
service Connection
{
@@ -97,7 +98,7 @@ service Connection
// DocMerge from xml: service com::sun::star::sdb::Connection: interface com::sun::star::sdb::XCommandPreparation
- /** interface for complex command execution
+ /** interface for complex command execution.
*/
interface XCommandPreparation;
@@ -126,6 +127,12 @@ service Connection
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.3.24.1 2002/02/18 10:23:31 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.3 2000/11/08 12:43:30 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:36 hjs
initial import
diff --git a/offapi/com/sun/star/sdb/ContentLoader.idl b/offapi/com/sun/star/sdb/ContentLoader.idl
index 7820f18b6..ae293ba31 100644
--- a/offapi/com/sun/star/sdb/ContentLoader.idl
+++ b/offapi/com/sun/star/sdb/ContentLoader.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: ContentLoader.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:28 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -72,9 +72,11 @@ module com { module sun { module star { module sdb {
//=============================================================================
/** implements a loader for various datasource-related user interface components.
- <p>Usually, you don't deal with this loader directly. Instead it is registered for
+ <p>
+ Usually, you don't deal with this loader directly. Instead it is registered for
a particular URL scheme, and you use the dispatch mechanism provided by the application
- framework, dispatching URLs the loader is registered for.</p>
+ framework, dispatching URLs the loader is registered for.
+ </p>
@see com::sun::star::frame::XDispatch
@see com::sun::star::frame::XDispatchProvider
@@ -83,24 +85,46 @@ service ContentLoader
{
/** ensures the basic functionality.
- <p>Supporting this service ensures that you can plug any of the components
- the loader can create into an arbitrary frame.</p>
+ <p>
+ Supporting this service ensures that you can plug any of the components
+ the loader can create into an arbitrary frame.
+ </p>
- The loader should be registered for the URL scheme <b>.component:DB/ *</b>,
- the concrete URLs supported are:
+ The loader should be registered for the URL scheme
+ <b>
+ .component:DB/ *
+ </b>
+ , the concrete URLs supported are:
<ul>
- <li><b>.component:DB/DataSourceBrowser</b><br/>
- Using this URL creates an instance of the <service>DataSourceBrowser</service> service
- and plugs it into the frame passed to the loader.
+ <li>
+ <b>
+ .component:DB/DataSourceBrowser
+ </b>
+ <br/>
+ Using this URL creates an instance of the
+ <service scope="com::sun::star::sdb">
+ DataSourceBrowser
+ </service>
+ service and plugs it into the frame passed to the loader.
</li>
- <li><b>.component:DB/FormGridView</b><br/>
- Using this URL creates an instance of the <service>ExternalSourceBrowser</service> service
- and plugs it into the frame passed to the loader.
+ <li>
+ <b>
+ .component:DB/FormGridView
+ </b>
+ <br/>
+ Using this URL creates an instance of the
+ <service scope="com::sun::star::sdb">
+ ExternalSourceBrowser
+ </service>
+ service and plugs it into the frame passed to the loader.
</li>
</ul>
- The parameters passed to the <member scope="com::sun::star::frame">XFrameLoader::load</member> are forwarded
- to the object beeing created, in particular to it's <type scope="com::sun::star::lang">XIntialization</type>
+ The parameters passed to the
+ <member scope="com::sun::star::frame">XFrameLoader::load()</member>
+ are forwarded to the object beeing created,
+ in particular to it's
+ <type scope="com::sun::star::lang">XIntialization</type>
interface.
**/
service com::sun::star::frame::FrameLoader;
diff --git a/offapi/com/sun/star/sdb/DataColumn.idl b/offapi/com/sun/star/sdb/DataColumn.idl
index 44e823eee..d8345b4ed 100644
--- a/offapi/com/sun/star/sdb/DataColumn.idl
+++ b/offapi/com/sun/star/sdb/DataColumn.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: DataColumn.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:43:30 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:28 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -104,14 +104,6 @@ service DataColumn
// DocMerge from xml: property com::sun::star::sdb::DataColumn::OriginalValue
/** contains the original value of the column.
-
-
-
-
-
-
-
-
@optional
*/
[optional, readonly, property] any OriginalValue;
@@ -123,6 +115,12 @@ service DataColumn
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.3.24.1 2002/02/18 10:22:06 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.3 2000/11/08 12:43:30 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:36 hjs
initial import
diff --git a/offapi/com/sun/star/sdb/DataSettings.idl b/offapi/com/sun/star/sdb/DataSettings.idl
index 5f1748d2f..4a76c6604 100644
--- a/offapi/com/sun/star/sdb/DataSettings.idl
+++ b/offapi/com/sun/star/sdb/DataSettings.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: DataSettings.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:29 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -73,10 +73,11 @@
// DocMerge from xml: service com::sun::star::sdb::DataSettings
-/** extends the <type scope="com::sun::star::sdbcx">Table</type> with additional
- display informations, sorting and filtering criterias.
+/** extends the
+ <type scope="com::sun::star::sdbcx">Table</type>
+ with additional display information, sorting and filtering criterias.
-<!-- JRH: invisible: <type scope="com::sun::star::sdbcx">Table</type> --> */
+ */
service DataSettings
{
@@ -123,6 +124,15 @@ service DataSettings
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.2.2 2002/06/27 12:34:27 oj
+ information corrected
+
+ Revision 1.5.2.1 2002/02/18 10:22:00 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.4 2000/12/14 12:53:38 mi
<true></true> -> <TRUE/> and same with FALSE
diff --git a/offapi/com/sun/star/sdb/DataSource.idl b/offapi/com/sun/star/sdb/DataSource.idl
index 1eb2936fb..2bf65094f 100644
--- a/offapi/com/sun/star/sdb/DataSource.idl
+++ b/offapi/com/sun/star/sdb/DataSource.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: DataSource.idl,v $
*
- * $Revision: 1.10 $
+ * $Revision: 1.11 $
*
- * last change: $Author: oj $ $Date: 2002-08-05 07:38:37 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:29 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -124,8 +124,13 @@ service DataSource
/** provides the access to DataSource related queries.
- <p>The object returned by the <method>XQueryDefinitionsSupplier::getQueryDefinitions</method> supports the
- <service>DefinitionContainer</service> service.</p>
+ <p>
+ The object returned by the
+ <method scope="com::sun::star::sdb">XQueryDefinitionsSupplier::getQueryDefinitions()</method>
+ supports the
+ <service scope="com::sun::star::sdb">DefinitionContainer</service>
+ service.
+ </p>
*/
interface XQueryDefinitionsSupplier;
@@ -134,8 +139,13 @@ service DataSource
interface com::sun::star::sdbc::XDataSource;
/** provides access to bookmarks to documents associated with the data source
- <p>The object returned by the <method>XBookmarksSupplier::getBookmarks</method> supports the
- <service>DefinitionContainer</service> service.</p>
+ <p>
+ The object returned by the
+ <method scope="com::sun::star::sdb">XBookmarksSupplier::getBookmarks()</method>
+ supports the
+ <service scope="com::sun::star::sdb">DefinitionContainer</service>
+ service.
+ </p>
*/
[optional] interface XBookmarksSupplier;
@@ -145,8 +155,9 @@ service DataSource
/** indicates a database url of the form <br>
- <code> jdbc:<em>subprotocol</em>:<em>subname</em></code> or
- <code> sdbc:<em>subprotocol</em>:<em>subname</em></code>
+ <code> jdbc:<em>subprotocol</em>:<em>subname</em></code>
+ or
+ <code>sdbc:<em>subprotocol</em>:<em>subname</em></code>
*/
[property] string URL;
@@ -174,7 +185,7 @@ service DataSource
/** indicates that components displaying data obtained from this
- data source should suppress columns used for versioning.
+ data source should suppress columns used for versioning.
*/
[property] boolean SuppressVersionColumns;
@@ -191,16 +202,16 @@ service DataSource
/** defines a list of tables, on which the DataSource should have it's focus.
- If empty, all the tables of the are used.
+ If empty, all tables are rejected.
-<!-- JRH: the second line is incomplete --> */
+ */
[property] sequence<string> TableFilter;
/** defines a list of table types, on which the DataSource should have it's focus.
- If empty, all the table types of the are used.
+ If empty, all table types are rejected.
-<!-- JRH: the second line is incomplete --> */
+ */
[property] sequence<string> TableTypeFilter;
};
@@ -208,61 +219,4 @@ service DataSource
}; }; }; };
-/*===========================================================================
- $Log: not supported by cvs2svn $
- Revision 1.9 2002/07/08 15:21:26 obo
- #100000#
-
- Revision 1.8 2002/06/17 07:01:55 oj
- interface XDataSource was missing.
-
- Revision 1.7.2.2 2002/06/17 07:00:12 oj
- interface XDataSource was missing.
-
- Revision 1.7.2.1 2002/02/18 10:23:09 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/04/26 09:13:56 fs
- added (optional) interface XBookmarksSupplier
-
- Revision 1.5 2001/02/07 11:11:30 fs
- a new missing detail ...
-
- Revision 1.4 2001/02/06 07:56:02 fs
- removed XFormDocumentsSupplier / XReportDocumentsSupplier from the service description - they're obsolete
-
- Revision 1.3 2000/11/08 12:43:30 mi
- moved from api
-
- Revision 1.2 2000/10/20 09:42:58 fs
- new property SuppressVersionColumns
-
- Revision 1.1.1.1 2000/09/18 23:35:36 hjs
- initial import
-
- Revision 1.8 2000/09/11 11:52:39 mi
- documentation merged from XML
-
- Revision 1.6 2000/07/05 17:12:07 os
- wrong property name corrected: NumberFormats -> NumberFormatsSupplier
-
- Revision 1.5 2000/06/27 06:57:50 dg
- CommandPreparation new
-
- Revision 1.4 2000/06/08 08:31:08 dg
- XDatabaseAccess is no longer part of the DataSource
-
- Revision 1.3 2000/06/05 13:35:37 dg
- services changed
-
- Revision 1.2 2000/06/05 13:20:27 dg
- services changed
-
- Revision 1.1 1999/11/24 08:39:00 dg
- new Star Data Beans
-
-===========================================================================*/
#endif
diff --git a/offapi/com/sun/star/sdb/DataSourceBrowser.idl b/offapi/com/sun/star/sdb/DataSourceBrowser.idl
index 2439ee2c9..5fc928720 100644
--- a/offapi/com/sun/star/sdb/DataSourceBrowser.idl
+++ b/offapi/com/sun/star/sdb/DataSourceBrowser.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: DataSourceBrowser.idl,v $
*
- * $Revision: 1.6 $
+ * $Revision: 1.7 $
*
- * last change: $Author: jsc $ $Date: 2001-10-31 15:32:53 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:29 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -81,76 +81,132 @@ module com { module sun { module star { module sdb {
//=============================================================================
/** implements a component which allows browsing the data sources registered on the system.
- <p>This service implements a user interface for browsing data sources registered on the
- <service>DatabaseContext</service> instance of the system.</p>
+ <p>
+ This service implements a user interface for browsing data sources registered on the
+ <service scope="com::sun::star::sdb">
+ DatabaseContext
+ </service>
+ instance of the system.
+ </p>
- <p>It is possible to navigate through all the data sources, it's queries and it's tables.
+ <p>
+ It is possible to navigate through all the data sources, it's queries and it's tables.
The queries/tables can be displayed in a grid-like view, where functionality for searching,
- sorting, filtering, and such is provided</p>
+ sorting, filtering, and such is provided.
+ </p>
- <p>Usually, you won't instantiate this service directly, instead you use the dispatch mechanisms
+ <p>
+ Usually, you won't instantiate this service directly, instead you use the dispatch mechanisms
of the application framework to load the URL <b>.component:DB/DataSourceBrowser</b> into an arbitrary
- frame. This should involve a <service>ContentLoader</service> service, which creates and initializes
- the browser.</p>
+ frame. This should involve a
+ <service scope="com::sun::star::sdb">
+ ContentLoader
+ </service>
+ service, which creates and initializes
+ the browser.
+ </p>
- <p>Some aspects of the browser can be controlled from outside, eg., it is possible to dispatch a sort or filter
- request, if a table or query is being displayed.</p>
+ <p>
+ Some aspects of the browser can be controlled from outside, eg.,
+ it is possible to dispatch a sort or filter
+ request, if a table or query is being displayed.
+ </p>
- <p>The communication between the browser and external instances works in two ways.<br>
- The way <em>in</em> is provided by the <type scope="com::sun::star::frame">XDispatchProvider</type> interface
- the service exports (Please see below for more details on this).<br>
- The way <em>out</em> works in another way. There are several URL's which an external instance can provide
- dispatches for (usually by implementing a <type scope="com::sun::star::frame">XDispatchProviderInterceptor</type>
- for the parent frame of the browser), thus indicating that the browser should provide special functionality.<br>
+ <p
+ >The communication between the browser and external instances works in two ways.
+ <br/>
+ The way <em>in</em> is provided by the
+ <type scope="com::sun::star::frame">XDispatchProvider</type>
+ interface the service exports (Please see below for more details on this).
+ <br/>
+ The way <em>out</em> works in another way. There are several URL's which an external
+ instance can provide dispatches for (usually by implementing a
+ <type scope="com::sun::star::frame">XDispatchProviderInterceptor</type>
+ for the parent frame of the browser), thus indicating that the browser should provide special functionality.
+ <br/>
In this case, the browser displays and maintains some additional slots (to be more concrete: toolbox items), which,
- upon triggering, call the <member scope="com::sun::star::frame">XDispatch::dispatch</member> method of the object
- provided by the external instance.</p>
+ upon triggering, call the
+ <member scope="com::sun::star::frame">XDispatch::dispatch()</member>methodoftheobject
+ provided by the external instance.
+ </p>
- <p>In particular, the supported URL's for communicating to an external instance are:
+ <p>
+ In particular, the supported URL's for communicating to an external instance are:
<ul>
- <li><b>.uno:DataSourceBrowser/InsertColumns</b><br>
- Available whenever an external instance provides a dispatcher (<type scope="com::sun::star::frame">XDispatch</type>)
- for this URL.<br>
- Enabled, if at least one row in the grid view of a table or query is selected.<br>
+ <li><b>.uno:DataSourceBrowser/InsertColumns</b>
+ <br/>
+ Available whenever an external instance provides a dispatcher (
+ <type scope="com::sun::star::frame">XDispatch</type>)
+ for this URL.
+ <br/>
+ Enabled, if at least one row in the grid view of a table or query is selected.
+ <br/>
It is the task of the external instance to provide functionality for this URL, but usually it is used
- to implement some kind of "Data To Text" functionality.<br>
+ to implement some kind of "Data To Text" functionality.
+ <br/>
</li>
- <li><b>.uno:DataSourceBrowser/InsertContent</b><br>
- Available whenever an external instance provides a dispatcher
- (<type scope="com::sun::star::frame">XDispatch</type>) for this URL.<br>
- Enabled, if at least one row in the grid view of a table or query is selected.<br>
+ <li><b>.uno:DataSourceBrowser/InsertContent</b>
+ <br/>
+ Available whenever an external instance provides a dispatcher(
+ <type scope="com::sun::star::frame">XDispatch</type>
+ ) for this URL.
+ <br/>
+ Enabled, if at least one row in the grid view of a table or query is selected.
+ <br/>
It is the task of the external instance to provide functionality for this URL, but usually it is used
- to implement some kind of "Data To Fields" functionality.<br>
+ to implement some kind of "Data To Fields" functionality.
+ <br/>
</li>
- <li><b>.uno:DataSourceBrowser/FormLetter</b><br>
- Available whenever an external instance provides a dispatcher (<type scope="com::sun::star::frame">XDispatch</type>)
- for this URL.<br>
+ <li><b>.uno:DataSourceBrowser/FormLetter</b>
+ <br/>
+ Available whenever an external instance provides a dispatcher (
+ <type scope="com::sun::star::frame">XDispatch</type>)forthisURL.
+ <br/>
It is the task of the external instance to provide functionality for this URL, but usually it is used
- to implement some kind of "Form Letter" functionality.<br>
+ to implement some kind of "Form Letter" functionality.
+ <br/>
</li>
</ul>
For all kinds of URL's, the parameters supplied when dispatching it are as follows:
<ul>
- <li><b>DataSourceName</b><br>
- The name of the globally registered <service>DataSource</service> from which the currently displayed data is
- taken.
+ <li><b>DataSourceName</b>
+ <br/>
+ The name of the globally registered
+ <service>
+ DataSource
+ </service>
+ from which the currently displayed data is taken.
</li>
- <li><b>CommandType</b><br>
- A <type>CommandType</type> value, specifying the type of the object displayed currently.
+ <li><b>CommandType</b>
+ <br/>
+ A
+ <type>
+ CommandType
+ </type>
+ value, specifying the type of the object displayed currently.
</li>
- <li><b>Command</b><br>
+ <li><b>Command</b>
+ <br/>
A string value, specifying the name of the object displayed currently (or the SQL statement used to populate
the grid view).
</li>
- <li><b>Selection</b><br>
+ <li><b>Selection</b>
+ <br/>
A sequence of integers, containing the numbers of the rows currently selected.
</li>
- <li><b>Cursor</b> (optional)<br>
+ <li><b>Cursor</b> (optional)
+ <br/>
If available, this parameter contains an object implementing the
- <service scope="com::sun::star::sdb">ResultSet</service> service.
+ <service scope="com::sun::star::sdb">
+ ResultSet
+ </service>
+ service.
It may be used to obtain the data described by the <em>Selection</em> parameter (which otherwise
- would have to be retrieved from the <service>DatabaseContext</service>, using the information given
- in the other parameters).
+ would have to be retrieved from the
+ <service>
+ DatabaseContext
+ </service>
+ , using the information given in the other parameters).
</li>
</ul>
</p>
@@ -164,12 +220,16 @@ module com { module sun { module star { module sdb {
service DataSourceBrowser
{
/** implements basic form controller functionality.
- <p>With a data source browser implementing this interface, external components have access to
+ <p>
+ With a data source browser implementing this interface, external components have access to
<ul><li>the grid control which is used to display the currently selected table/query
- (see <method scope="com.sun.star.form">XFormController::getControls</method>)
+ (see
+ <method scope="com.sun.star.form">XFormController::getControls()</method>
+ )
</li>
<li>the data form used for displaying objects. As always for components implementing this service,
- the object returned by <method scope="com.sun.star.awt">XTabController::getModel</method> is a data form.
+ the object returned by
+ <method scope="com.sun.star.awt">XTabController::getModel()</method>isadataform.
</li>
</ul>
</p>
@@ -182,27 +242,49 @@ service DataSourceBrowser
/** is used to initialize the browser.
- <p>Parameters (passed to the method
- <member scope="com::sun::star::lang">XInitialization::initialize</member>)
- have to be instances of <type scope="com::sun::star::beans">PropertyValue</type>, where the
- <member scope="com::sun::star::beans">PropertyValue::Name</member> member specifies what the parameter controls,
- with the <member scope="com::sun::star::beans">PropertyValue::Value</member> member containing the value
- to be used.<br>
+ <p>
+ Parameters (passed to the method
+ <member scope="com::sun::star::lang">XInitialization::initialize()</member>
+ )
+ have to be instances of
+ <type scope="com::sun::star::beans">PropertyValue</type>
+ , where the
+ <member scope="com::sun::star::beans">PropertyValue::Name</member>
+ member specifies what the parameter controls,
+ with the
+ <member scope="com::sun::star::beans">PropertyValue::Value</member>
+ member containing the value
+ to be used.
+ <br/>
Recognized parameters are:
<ul>
- <li><b>Frame</b><br>
- has to be an <type scope="com::sun::star::frame">XFrame</type> interface specifying the frame to plug the
+ <li><b>Frame</b>
+ <br/>
+ has to be an
+ <type scope="com::sun::star::frame">XFrame</type>
+ interface specifying the frame to plug the
browser component into.
</li>
- <li><b>DataSourceName</b><br>
- The name of the globally registered <service>DataSource</service> to be used for initial display. It is only
+ <li><b>DataSourceName</b>
+ <br/>
+ The name of the globally registered
+ <service>
+ DataSource
+ </service>
+ to be used for initial display. It is only
meaningful together with the other parameters specifying the object to display.
</li>
- <li><b>CommandType</b><br>
- This has to be a <type>CommandType</type> value, specifying the type of the object to display initially.
+ <li><b>CommandType</b>
+ <br/>
+ This has to be a
+ <type>
+ CommandType
+ </type>
+ value, specifying the type of the object to display initially.
It is only meaningful together with the <em>DataSourceName</em> and the <em>Command</em> parameters.
</li>
- <li><b>Command</b><br>
+ <li><b>Command</b>
+ <br/>
This is a string giving the name of the object to display initially. Whether it is table name, a query
name or a SQL string is controller by the <em>CommandType</em> parameter.
</li>
@@ -213,30 +295,42 @@ service DataSourceBrowser
/** is used to control the browser from outside.
- <p>You may use the <member scope="com::sun::star::frame">XDispatchProvider::queryDispatch</member> method
- to query for objects which implement the <type scope="com::sun::star::frame">XDispatch</type> interface,
- and which allow you to be notified on status changes and to dispatch special requests.</p>
- <p>The recognized URLs are:
+ <p>
+ You may use the
+ <member scope="com::sun::star::frame">XDispatchProvider::queryDispatch</member>
+ method
+ to query for objects which implement the
+ <type scope="com::sun::star::frame">XDispatch</type>
+ interface,
+ and which allow you to be notified on status changes and to dispatch special requests.
+ </p>
+ <p>
+ The recognized URLs are:
<ul>
- <li><b>.uno:Copy</b><br>
+ <li><b>.uno:Copy</b>
+ <br/>
implements the usual <em>Copy</em> command. Enabled if the grid view has the focus and text in any cell
is selected.
</li>
- <li><b>.uno:Cut</b><br>
+ <li><b>.uno:Cut</b>
+ <br/>
implements the usual <em>Cut</em> command. Enabled if the grid view has the focus and text in any cell
is selected.
</li>
- <li><b>.uno:Paste</b><br>
+ <li><b>.uno:Paste</b>
+ <br/>
implements the usual <em>Paste</em> command. Enabled if the grid view has the focus and a cell which
allows text input is being edited.
</li>
- <li><b>.uno:EditDoc</b><br>
+ <li><b>.uno:EditDoc</b>
+ <br/>
allows switching the edit mode of the grid view. Enabled if editing the data is allowed in general.
</li>
- <li><b>.uno:Undo</b><br>
+ <li><b>.uno:Undo</b>
+ <br/>
revokes any changes done in the current row.
</li>
- <li><b>.uno:Save</b><br>
+ <li><b>.uno:Save</b><br/>
saves the changes done in the current row.
</li>
</ul>
diff --git a/offapi/com/sun/star/sdb/DatabaseAccess.idl b/offapi/com/sun/star/sdb/DatabaseAccess.idl
index 11fbd1bb3..76843cc32 100644
--- a/offapi/com/sun/star/sdb/DatabaseAccess.idl
+++ b/offapi/com/sun/star/sdb/DatabaseAccess.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: DatabaseAccess.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:30 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -86,7 +86,7 @@ interface XCompletedConnection;
*/
service DatabaseAccess
{
- // DocMerge: empty anyway
+ // gives access to the properties.
interface com::sun::star::beans::XPropertySet;
@@ -155,17 +155,16 @@ service DatabaseAccess
// DocMerge from idl: property com::sun::star::sdb::DatabaseAccess::TableFilter
/** defines a list of tables, on which the bean should have it's focus.
- If empty, all the tables of the are used.
-
-<!-- JRH: second sentence is incomplete -->*/
+ If empty, all tables are rejected.
+ */
[optional, property] sequence<string> TableFilter;
// DocMerge from idl: property com::sun::star::sdb::DatabaseAccess::TableTypeFilter
/** defines a list of table types, on which the bean should have it's focus.
- If empty, all the tables types of the are used.
+ If empty, all tables types are rejected.
-<!-- JRH: second sentence is incomplete --> */
+ */
[optional, property] sequence<string> TableTypeFilter;
};
@@ -175,6 +174,15 @@ service DatabaseAccess
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.2.2 2002/02/18 12:53:58 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5.2.1 2002/02/18 10:24:40 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.4 2001/01/23 10:08:25 mi
optional interfaces now marked as [optional] instead of just a prosa description of this fact
diff --git a/offapi/com/sun/star/sdb/DatabaseAccessConnection.idl b/offapi/com/sun/star/sdb/DatabaseAccessConnection.idl
index 649d82257..690b88fb5 100644
--- a/offapi/com/sun/star/sdb/DatabaseAccessConnection.idl
+++ b/offapi/com/sun/star/sdb/DatabaseAccessConnection.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: DatabaseAccessConnection.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:30 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -86,21 +86,26 @@ interface XSQLQueryComposerFactory;
to a certain database connection, such as, DatabaseQueries, FormDocuments, and ReportDocuments.
Objects for data definition are supplied as well, for instance, Tables, Views, etc.
- <p>Implements the service <type scope="com::sun::star::sdbc">Connection</type>.
- It is possible to open more than one connection at the same time, but the
- method <member>DatabaseAccessConnection::dispose</member> will close
- only one of these connections. You have to close all connections in order
- to close the connection to the database.</p>
+ <p>
+ Implements the service
+ <type scope="com::sun::star::sdbc">Connection</type>
+ .
+ It is possible to open more than one connection at the same time, but the method
+ <member scope="com::sun::star::sdb">DatabaseAccessConnection::dispose()</member>
+ will close only one of these connections. You have to close all connections in order
+ to close the connection to the database.
+ </p>
*/
service DatabaseAccessConnection
{
// DocMerge from xml: service com::sun::star::sdb::DatabaseAccessConnection: service com::sun::star::sdbc::Connection
/** supporting of the base connection service.
- <p><B>Note:</B><br>
- Don't use the "dispose" method of the XComponent interface, as the DataAccess
- uses a more sophisticated interface for closing a connection.
- @see XDatabaseAccess@see XDatabaseAccess
+ <p><B>Note:</B><br/>
+ Don't use the "dispose" method of the XComponent interface, as the DataAccess
+ uses a more sophisticated interface for closing a connection.
+ @see XDatabaseAccess
+ </p>
*/
service com::sun::star::sdbc::Connection;
@@ -122,7 +127,8 @@ service DatabaseAccessConnection
*/
interface XSQLQueryComposerFactory;
- // DocMerge: empty anyway
+ /** provides access to the queries.
+ */
interface XQueriesSupplier;
};
@@ -132,6 +138,15 @@ service DatabaseAccessConnection
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.2.2 2002/02/18 12:53:58 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4.2.1 2002/02/18 10:23:26 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/DatabaseAccessContext.idl b/offapi/com/sun/star/sdb/DatabaseAccessContext.idl
index d64ed53e7..a42dd0108 100644
--- a/offapi/com/sun/star/sdb/DatabaseAccessContext.idl
+++ b/offapi/com/sun/star/sdb/DatabaseAccessContext.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: DatabaseAccessContext.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:30 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -84,7 +84,8 @@
access beans. It is possible to have different aliases for different locales.
- <p>A DatabaseContext stores an alias for the URL of a database access component
+ <p>
+ A DatabaseContext stores an alias for the URL of a database access component
for a given locale. It is also allowed to work with a default locale. This is useful
in connection with Enumeration or NameAccess to the context. In common use, the
default language is set during the initialization of the component.
@@ -129,6 +130,12 @@ service DatabaseAccessContext
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.2.1 2002/02/18 10:23:42 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/DatabaseAccessDataSource.idl b/offapi/com/sun/star/sdb/DatabaseAccessDataSource.idl
index 52af73bdf..7b7257f5b 100644
--- a/offapi/com/sun/star/sdb/DatabaseAccessDataSource.idl
+++ b/offapi/com/sun/star/sdb/DatabaseAccessDataSource.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: DatabaseAccessDataSource.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:30 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -90,13 +90,16 @@ service DatabaseAccessDataSource
interface com::sun::star::beans::XPropertySet;
interface com::sun::star::sdbc::XDataSource;
- /** is optional for implementation. */
+ /** is optional for implementation.
+ */
[optional] interface XCompletedConnection;
- /** locates the database access bean. */
+ /** locates the database access bean.
+ */
[property] string URL;
- /** determines the password handling. */
+ /** determines the password handling.
+ */
[optional, property] com::sun::star::ucb::RememberAuthentication PasswordMode;
};
@@ -106,6 +109,12 @@ service DatabaseAccessDataSource
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.2.1 2002/02/18 10:26:32 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.4 2001/01/23 10:08:26 mi
optional interfaces now marked as [optional] instead of just a prosa description of this fact
diff --git a/offapi/com/sun/star/sdb/DatabaseContext.idl b/offapi/com/sun/star/sdb/DatabaseContext.idl
index ac9f7ac57..7ae272189 100644
--- a/offapi/com/sun/star/sdb/DatabaseContext.idl
+++ b/offapi/com/sun/star/sdb/DatabaseContext.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: DatabaseContext.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:30 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -65,6 +65,14 @@
#include <com/sun/star/container/XEnumerationAccess.idl>
#endif
+#ifndef __com_sun_star_container_XContainer_idl__
+#include <com/sun/star/container/XContainer.idl>
+#endif
+
+#ifndef __com_sun_star_lang_XSingleServiceFactory_idl__
+#include <com/sun/star/lang/XSingleServiceFactory.idl>
+#endif
+
#ifndef __com_sun_star_container_XNameAccess_idl__
#include <com/sun/star/container/XNameAccess.idl>
#endif
@@ -78,11 +86,14 @@
// DocMerge from xml: service com::sun::star::sdb::DatabaseContext
/** is the context for accessing datasource.
- <p>A datasource contains information how to create a connection to a database, such as, which databse driver
- should be used, for which user should a connection be established, etc. <br>
+ <p>
+ A datasource contains information how to create a connection to a database, such as,
+ which database driver should be used, for which user should a connection be established, etc.
+ <br/>
The context stores datasources under a given name.
- </p>@see com::sun::star::sdb::DataSource
+ </p>
+ @see com::sun::star::sdb::DataSource
*/
service DatabaseContext
{
@@ -103,6 +114,14 @@ service DatabaseContext
/** Interface for registering new datasources.
*/
interface com::sun::star::uno::XNamingService;
+
+ /** Interface for registering listener to get notified when new datasources are created or removed.
+ */
+ interface com::sun::star::container::XContainer;
+
+ /** Interface for creation of new datasources.
+ */
+ interface com::sun::star::lang::XSingleServiceFactory;
};
//=============================================================================
@@ -111,6 +130,12 @@ service DatabaseContext
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.2.1 2002/02/18 10:26:46 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/DatabaseDocument.idl b/offapi/com/sun/star/sdb/DatabaseDocument.idl
index c99c8e200..5f25078dc 100644
--- a/offapi/com/sun/star/sdb/DatabaseDocument.idl
+++ b/offapi/com/sun/star/sdb/DatabaseDocument.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: DatabaseDocument.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:43:31 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:31 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -79,21 +79,22 @@ interface XRename;
// DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::DatabaseDocument
/** specifies documents which belong to a database access bean.
-
-
- <p>These documents typically process information from a connected
- data source. A <type>DatabaseDocument</type> could be a form
- or a report.</p>
+ <p>
+ These documents typically process information from a connected
+ data source. A
+ <type scope="com::sun::star::sdb">DatabaseDocument</type>
+ could be a form or a report.
+ </p>
*/
service DatabaseDocument
{
- // DocMerge: empty anyway
+ // gives access to the properties.
interface com::sun::star::beans::XPropertySet;
- // DocMerge: empty anyway
+ // allows to create new DatabaseDocument objects
interface com::sun::star::sdbcx::XDataDescriptorFactory;
- // DocMerge: empty anyway
+ // allows to rename the object.
interface com::sun::star::sdbcx::XRename;
// DocMerge from xml: property com::sun::star::sdbcx::com::sun::star::sdb::DatabaseDocument::Name
@@ -114,6 +115,15 @@ service DatabaseDocument
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.3.24.2 2002/02/18 12:53:58 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.3.24.1 2002/02/18 10:21:53 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.3 2000/11/08 12:43:31 mi
+ moved from api
+
Revision 1.2 2000/10/17 08:42:32 fs
removed the obsolete chaos::XDataStreamSupplier
diff --git a/offapi/com/sun/star/sdb/DatabaseEnvironment.idl b/offapi/com/sun/star/sdb/DatabaseEnvironment.idl
index 6824f9218..cc8f4f78e 100644
--- a/offapi/com/sun/star/sdb/DatabaseEnvironment.idl
+++ b/offapi/com/sun/star/sdb/DatabaseEnvironment.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: DatabaseEnvironment.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:43:31 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:31 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -76,7 +76,8 @@ interface XDatabaseEnvironment;
// DocMerge from xml: service com::sun::star::sdb::DatabaseEnvironment
-/** is the top level service for accessing database components.
+/** @deprecated
+ is the top level service for accessing database components.
@@ -106,6 +107,12 @@ service DatabaseEnvironment
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.3.24.1 2002/02/18 10:23:03 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.3 2000/11/08 12:43:31 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:36 hjs
initial import
diff --git a/offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl b/offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl
index c3e55353e..d0f179bd5 100644
--- a/offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl
+++ b/offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: DatasourceAdministrationDialog.idl,v $
*
- * $Revision: 1.8 $
+ * $Revision: 1.9 $
*
- * last change: $Author: kz $ $Date: 2002-07-09 10:30:14 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:31 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -84,8 +84,14 @@ module com { module sun { module star { module sdb {
/** provides a user interface for administrating the system wide registered data sources.
- <p>Here, <em>system wide registered</em> means registered on the (one and only) instance
- of the <service>DatabaseContext</service> service.</p>
+ <p>
+ Here, <em>system wide registered</em> means registered on the (one and only) instance
+ of the
+ <service scope="com::sun::star::sdb">
+ DatabaseContext
+ </service>
+ service.
+ </p>
*/
service DatasourceAdministrationDialog
{
@@ -94,7 +100,9 @@ service DatasourceAdministrationDialog
[property] string Title;
/** parent window to use for the administration dialog
- <p>This property can't be set while the dialog is being displayed.</p>
+ <p>
+ This property can't be set while the dialog is being displayed.
+ </p>
*/
[property] com::sun::star::awt::XWindow ParentWindow;
@@ -107,27 +115,40 @@ service DatasourceAdministrationDialog
interface com::sun::star::ui::dialogs::XExecutableDialog;
/** allows initializing the dialog
- <p>You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments
- method of your <type scope="com::sun::star::lang">XMultiServiceFactory</type>.</p>
+ <p>
+ You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments
+ method of your
+ <type scope="com::sun::star::lang">XMultiServiceFactory</type>
+ .
+ </p>
- <p>You specify a parameter by passing one (or more) <type scope="com::sun::star::beans">PropertyValue</type>
+ <p>
+ You specify a parameter by passing one (or more)
+ <type scope="com::sun::star::beans">PropertyValue</type>
object(s) to the initialize method, where the <em>Name</em> field contains a string describing which aspect
you want to affect, and the <em>Value</em> field containing a value.
- <br>
- Imagine the initialization values as if you use setPropertyValue of the <type scope="com::sun::star::beans">XPropertySet</type>
+ <br/>
+ Imagine the initialization values as if you use setPropertyValue of the
+ <type scope="com::sun::star::beans">XPropertySet</type>
interface ...
- <br>
+ <br/>
allowed parameters are
<ul>
<li><b>Title</b><br/>
- String describing the initial title of the dialog. If not specified, a default title is used.
+ String describing the initial title of the dialog.
+ If not specified, a default title is used.
</li>
<li><b>ParentWindow</b><br/>
- <type scope="com::sun::star::awt">XWindow</type> describing the parent window to use for the dialog.
+ <type scope="com::sun::star::awt">XWindow</type>
+ describing the parent window to use for the dialog.
</li>
<li><b>InitialSelection</b><br/>
- String describing which data source should be selected initially. This name must be known to the
- <service>DatabaseContext</service>.
+ String describing which data source should be selected initially.
+ This name must be known to the
+ <service scope="com::sun::star::sdb">
+ DatabaseContext
+ </service>
+ .
</li>
</ul>
</p>
@@ -139,31 +160,4 @@ service DatasourceAdministrationDialog
}; }; }; };
-/*************************************************************************
- * history:
- * $Log: not supported by cvs2svn $
- * Revision 1.7 2001/10/25 15:00:32 mi
- * proofreading and corrections from Richard Holt
- *
- * Revision 1.6 2001/07/03 09:00:57 tra
- * must change com/sun/star/ui -> com/sun/star/ui/dialogs/
- *
- * Revision 1.5 2001/03/16 16:41:32 jsc
- * remove interfaceheader with uik and remove [const] in method definitions
- *
- * Revision 1.4 2001/02/20 14:32:12 fs
- * syntax
- *
- * Revision 1.3 2000/11/08 12:43:31 mi
- * moved from api
- *
- * Revision 1.1 2000/11/01 17:00:53 fs
- * initial checkin - the service for an user interface for administrating data sources
- *
- *
- * Revision 1.0 01.11.00 17:37:14 fs
- ************************************************************************/
-
-// __com_sun_star_sdb_DatasourceAdministrationDialog_idl__
-
#endif
diff --git a/offapi/com/sun/star/sdb/DefinitionContainer.idl b/offapi/com/sun/star/sdb/DefinitionContainer.idl
index c0463dbdc..ef5a41759 100644
--- a/offapi/com/sun/star/sdb/DefinitionContainer.idl
+++ b/offapi/com/sun/star/sdb/DefinitionContainer.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: DefinitionContainer.idl,v $
*
- * $Revision: 1.6 $
+ * $Revision: 1.7 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:32 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -86,23 +86,26 @@ interface XSingleServiceFactory;
The container supports access to its elements by the elements name or
by the elements position.
</p>
- <p>Simple enumeration must be supported as well.
+ <p>
+ Simple enumeration must be supported as well.
+ </p>
+ <p>
+ To reflect the changes with the underlying database, a refresh mechanism
+ needs to be supported.
</p>
- <p>To reflect the changes with the underlying database, a refresh mechanism
- needs to be supported. </p>
*/
service DefinitionContainer
{
- // DocMerge: empty anyway
+ // gives access to the elements by name.
interface com::sun::star::container::XNameAccess;
- // DocMerge: empty anyway
+ // allows to insert and remove by name.
interface com::sun::star::container::XNameContainer;
- // DocMerge: empty anyway
+ // gives access to the elements by index.
interface com::sun::star::container::XIndexAccess;
- // DocMerge: empty anyway
+ // allows to create an enumeration of the elements.
interface com::sun::star::container::XEnumerationAccess;
@@ -112,9 +115,11 @@ service DefinitionContainer
[optional] interface com::sun::star::util::XRefreshable;
/** can be used to create container elements.
- <p>If this interface is supported, the object created using it (e.g., the object returned by
- <method scope="com.sun.star.lang">XSingleServiceFactory::createInstance</method>) can be used as
- container elements.</p>
+ <p>
+ If this interface is supported, the object created using it (e.g., the object returned by
+ <method scope="com.sun.star.lang">XSingleServiceFactory::createInstance()</method>
+ ) can be used as container elements.
+ </p>
*/
[optional] interface com::sun::star::lang::XSingleServiceFactory;
};
@@ -125,6 +130,15 @@ service DefinitionContainer
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.6.2.2 2002/02/18 12:53:58 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.6.2.1 2002/02/18 10:23:14 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.6 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.5 2001/02/07 13:15:17 fs
added an optional interface XSingleServiceFactory
diff --git a/offapi/com/sun/star/sdb/DocumentDefinition.idl b/offapi/com/sun/star/sdb/DocumentDefinition.idl
index 864a51687..a45582527 100644
--- a/offapi/com/sun/star/sdb/DocumentDefinition.idl
+++ b/offapi/com/sun/star/sdb/DocumentDefinition.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: DocumentDefinition.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:32 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -69,9 +69,13 @@ module com { module sun { module star { module sdb {
/** specifies documents which belong to a database source.
- <p>These documents typically process information from a connected
- data source. A <type>Document</type> could be a form
- or a report.
+ <p>
+ These documents typically process information from a connected
+ data source. A
+ <type>
+ Document
+ </type>
+ could be a form or a report.
@deprecated
*/
diff --git a/offapi/com/sun/star/sdb/ErrorMessageDialog.idl b/offapi/com/sun/star/sdb/ErrorMessageDialog.idl
index eb0c490a0..977052ddc 100644
--- a/offapi/com/sun/star/sdb/ErrorMessageDialog.idl
+++ b/offapi/com/sun/star/sdb/ErrorMessageDialog.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: ErrorMessageDialog.idl,v $
*
- * $Revision: 1.6 $
+ * $Revision: 1.7 $
*
- * last change: $Author: rt $ $Date: 2002-06-17 16:12:08 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:33 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -84,13 +84,32 @@ module com { module sun { module star { module sdb {
/** provides a dialog for displaying database related exceptions.
- <p>If applications use any of the functionality provided in the modules
- <module scope="com.sun.star">sdbc</module>, <module scope="com.sun.star">sdbcx</module> and <module scope="com.sun.star">sdb</module>,
- they will - sooner or later - encounter <type scope="com.sun.star.sdbc">SQLException</type>'s.<br>
- These exceptions can be chained, so the information wrapped in one single <type scope="com.sun.star.sdbc">SQLException</type>
+ <p>
+ If applications use any of the functionality provided in the modules
+ <module scope="com.sun.star">
+ sdbc
+ </module>
+ ,
+ <module scope="com.sun.star">
+ sdbcx
+ </module>
+ and
+ <module scope="com.sun.star">
+ sdb
+ </module>
+ ,
+ they will - sooner or later - encounter
+ <type scope="com.sun.star.sdbc">SQLException</type>
+ 's.
+ <br/>
+ These exceptions can be chained, so the information wrapped in one single
+ <type scope="com.sun.star.sdbc">SQLException</type>
can be rather complex (e.g., every instance where such an exception is passing before it is finally caught, could
- append a <type scope="com.sun.star.sdb">SQLContext</type> to explain what it was doing), and they should be
- presented to the user in a consistent way.<br>
+ append a
+ <type scope="com.sun.star.sdb">SQLContext</type>
+ to explain what it was doing), and they should be
+ presented to the user in a consistent way.
+ <br/>
This can be reached by using this service.
@see com.sun.star.sdb.InteractionHandler
</p>
@@ -102,14 +121,22 @@ service ErrorMessageDialog
[property] string Title;
/** parent window to use for the dialog
- <p>This property can't be set while the dialog is being displayed.</p>
+ <p>
+ This property can't be set while the dialog is being displayed.
+ </p>
*/
[property] com::sun::star::awt::XWindow ParentWindow;
/** is the exception displayed by the dialog
- <p>This should contain a <type scope="com.sun.star.sdbc">SQLException</type> instance, or an instance
- of any class derived from this exception.</p>
- <p>This property can't be set while the dialog is being displayed.</p>
+ <p>
+ This should contain a
+ <type scope="com.sun.star.sdbc">SQLException</type>
+ instance, or an instance
+ of any class derived from this exception.
+ </p>
+ <p>
+ This property can't be set while the dialog is being displayed.
+ </p>
*/
[property] any SQLException;
@@ -122,26 +149,40 @@ service ErrorMessageDialog
interface com::sun::star::ui::dialogs::XExecutableDialog;
/** allows initializing the dialog
- <p>You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments
- method of your <type scope="com::sun::star::lang">XMultiServiceFactory</type>.</p>
- <p>You specify a parameter by passing one (or more) <type scope="com::sun::star::beans">PropertyValue</type>
+ <p>
+ You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments
+ method of your
+ <type scope="com::sun::star::lang">XMultiServiceFactory</type>
+ .
+ </p>
+ <p>
+ You specify a parameter by passing one (or more)
+ <type scope="com::sun::star::beans">PropertyValue</type>
object(s) to the initialize method, where the <em>Name</em> field contains a string describing which aspect
you want to affect, and the <em>Value</em> field containing a value.
- <br>
- Imagine the initialization values, as if you use setPropertyValue of the <type scope="com::sun::star::beans">XPropertySet</type>
+ <br/>
+ Imagine the initialization values, as if you use
+ <method scope="com::sun::star::beans">XPropertySet::setPropertyValue()
+ </method>
+ of the
+ <type scope="com::sun::star::beans">XPropertySet</type>
interface ...
- <br>
+ <br/>
allowed parameters are
<ul>
- <li><b>Title</b><br>
+ <li><b>Title</b><br/>
String describing the initial title of the dialog. If not specified, a default title is used.
</li>
- <li><b>ParentWindow</b><br>
- <type scope="com::sun::star::awt">XWindow</type> describing the parent window to use for the dialog.
+ <li><b>ParentWindow</b><br/>
+ <type scope="com::sun::star::awt">XWindow</type>
+ describing the parent window to use for the dialog.
</li>
- <li><b>SQLException</b><br>
- <type scope="com::sun::star::sdbc">SQLException</type> describing the error which is beeing displayed.<br>
- When initializing this value, you may use any derivative of <type scope="com::sun::star::sdbc">SQLException</type>.
+ <li><b>SQLException</b><br/>
+ <type scope="com::sun::star::sdbc">SQLException</type>
+ describing the error which is beeing displayed.<br/>
+ When initializing this value, you may use any derivative of
+ <type scope="com::sun::star::sdbc">SQLException</type>
+ .
</li>
</ul>
</p>
@@ -153,25 +194,5 @@ service ErrorMessageDialog
}; }; }; };
-/*************************************************************************
- * history:
- * $Log: not supported by cvs2svn $
- * Revision 1.5 2001/10/25 15:00:32 mi
- * proofreading and corrections from Richard Holt
- *
- * Revision 1.4 2001/07/03 09:00:57 tra
- * must change com/sun/star/ui -> com/sun/star/ui/dialogs/
- *
- * Revision 1.3 2001/03/16 16:41:32 jsc
- * remove interfaceheader with uik and remove [const] in method definitions
- *
- * Revision 1.2 2001/03/12 16:26:34 fs
- * ooops .... corrected the name of the SQLException property
- *
- * Revision 1.1 2001/02/20 14:32:46 fs
- * initial checkin - service description for the ErrorMessageDialog
- *
- ************************************************************************/
-
#endif
diff --git a/offapi/com/sun/star/sdb/InteractionHandler.idl b/offapi/com/sun/star/sdb/InteractionHandler.idl
index 9e89a1487..a236ccc70 100644
--- a/offapi/com/sun/star/sdb/InteractionHandler.idl
+++ b/offapi/com/sun/star/sdb/InteractionHandler.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: InteractionHandler.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:33 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -68,40 +68,57 @@
module com { module sun { module star { module sdb {
-/** is a service for user interaction for databases.</p>
+/** is a service for user interaction for databases.
+ <p>
interaction requests that the handler can provide are:
<ul>
- <li><b>database related errors</b><br>
- The general structure to transport such errors is the <type scope="com.sun.star.sdbc">SQLException</type>,
- and if your <type scope="com.sun.star.task">XInteractionRequest</type> supplies such a
- <type scope="com.sun.star.sdbc">SQLException</type> (or an instance of any derived class),
+ <li><b>database related errors</b><br/>
+ The general structure to transport such errors is the
+ <type scope="com.sun.star.sdbc">SQLException</type>
+ , and if your
+ <type scope="com.sun.star.task">XInteractionRequest</type>
+ supplies such a
+ <type scope="com.sun.star.sdbc">SQLException</type>
+ (or an instance of any derived class),
the handler will display a generic error dialog, which is able
to travel the object chain which may be contained in the exception.
</li>
- <li><b>authentication</b><br>
- If your <type scope="com.sun.star.task">XInteractionRequest</type>
- (see <member scope="com.sun.star.task">XInteractionHandler::handle</member>) supplies a
- <type scope="com.sun.star.ucb">AuthenticationRequest</type>, the handler will open a standard login
+ <li><b>authentication</b><br/>
+ If your
+ <type scope="com.sun.star.task">XInteractionRequest</type>
+ (see
+ <member scope="com.sun.star.task">XInteractionHandler::handle()</member>
+ ) supplies a
+ <type scope="com.sun.star.ucb">AuthenticationRequest</type>
+ , the handler will open a standard login
dialog to allow user authentication.
- <br>
+ <br/>
Besides the using the members of the AuthenticationRequest in the usual manner, the member <em>Server</em>
(if not empty) is interpreted as datasource name, thus leading to a slightly different message when
requesting the user to enter it's login data.
- <br>
+ <br/>
In the case you want to use this authentication feature, you should supply a special authentication
- continuation (<type scope="com.sun.star.ucb">XInteractionSupplyAuthentication</type>) as well, so the
+ continuation (
+ <type scope="com.sun.star.ucb">XInteractionSupplyAuthentication</type>
+ ) as well, so the
handler can return to you, the entered information.
</li>
- <li><b>parameter requests</b><br>
- If your <type scope="com.sun.star.task">XInteractionRequest</type> supplies an
- <type scope="com.sun.star.ucb">ParametersRequest</type>, the handler will open a standard dialog asking
+ <li><b>parameter requests</b><br/>
+ If your
+ <type scope="com.sun.star.task">XInteractionRequest</type>
+ supplies an
+ <type scope="com.sun.star.ucb">ParametersRequest</type>
+ , the handler will open a standard dialog asking
the user to fill in parameter values.
- <br>
+ <br/>
In the case you want to use this feature of the handler, you should supply a special continuation
- (<type scope="com.sun.star.sdb">XInteractionSupplyParameters</type>) as well, so the
+ (
+ <type scope="com.sun.star.sdb">XInteractionSupplyParameters</type>
+ ) as well, so the
handler can return to you, the entered information.
</li>
</ul>
+ </p>
*/
service InteractionHandler
{
@@ -116,6 +133,12 @@ service InteractionHandler
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.2.1 2002/02/18 10:26:06 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.4 2000/12/19 16:03:41 mi
documentations syntax errors fixed
diff --git a/offapi/com/sun/star/sdb/ParametersRequest.idl b/offapi/com/sun/star/sdb/ParametersRequest.idl
index f8bb134b0..a9a199f70 100644
--- a/offapi/com/sun/star/sdb/ParametersRequest.idl
+++ b/offapi/com/sun/star/sdb/ParametersRequest.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: ParametersRequest.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:33 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -78,20 +78,28 @@
//=============================================================================
-/** an error specifying the lack of parameters values</p>
+/** an error specifying the lack of parameters values
+ <p>
Usually thrown if someone tries to execute an SQL statement containing
parameters which can't be filled by the executing instance.
+ </p>
*/
exception ParametersRequest: com::sun::star::task::ClassifiedInteractionRequest
{
- /** is the list of parameters requested.</p>
- The objects returned by the <type scope="com.sun.star.container">XIndexAccess</type> have to
+ /** is the list of parameters requested.
+ The objects returned by the
+ <type scope="com.sun.star.container">XIndexAccess</type>
+ have to
be property sets describing the respective parameter. For this, the objects have to support the
- service <service scope="com.sun.star.sdbcx">Column</service>.
+ service
+ <service scope="com.sun.star.sdbcx">
+ Column
+ </service>
+ .
*/
com::sun::star::container::XIndexAccess Parameters;
- /** specifies the connection on which the statement is to be executed.</p>
+ /** specifies the connection on which the statement is to be executed.
Somebody handling the request could, e.g., use the connection for determining
the identifier quote string, etc.
*/
@@ -105,6 +113,12 @@ exception ParametersRequest: com::sun::star::task::ClassifiedInteractionRequest
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.2.1 2002/02/18 10:22:59 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/PreparedStatement.idl b/offapi/com/sun/star/sdb/PreparedStatement.idl
index 12169364b..88efbf230 100644
--- a/offapi/com/sun/star/sdb/PreparedStatement.idl
+++ b/offapi/com/sun/star/sdb/PreparedStatement.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: PreparedStatement.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:43:31 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:33 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -74,7 +74,9 @@ interface XColumnsSupplier;
// DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::PreparedStatement
/** represents a precompiled SQL statement. The service differs only in the access
- of the columns and parameters to the service <type scope="com::sun::star::sdbc">PreparedStatement</type>.
+ of the columns and parameters to the service
+ <type scope="com::sun::star::sdbc">PreparedStatement</type>
+ .
*/
service PreparedStatement
{
@@ -94,6 +96,12 @@ service PreparedStatement
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.3.24.1 2002/02/18 10:23:19 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.3 2000/11/08 12:43:31 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:36 hjs
initial import
diff --git a/offapi/com/sun/star/sdb/Query.idl b/offapi/com/sun/star/sdb/Query.idl
index 6cda12658..bd9edd9fe 100644
--- a/offapi/com/sun/star/sdb/Query.idl
+++ b/offapi/com/sun/star/sdb/Query.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: Query.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:34 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -85,9 +85,11 @@ interface XRename;
// DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::Query
/** is a stored definition of a SQL query.
- <p>It can be used if there is a need to execute SQL statements more than once, or
+ <p>
+ It can be used if there is a need to execute SQL statements more than once, or
if you want to format the query result fields differently from the
- underlying table definitions.</p>
+ underlying table definitions.
+ </p>
*/
service Query
{
@@ -109,7 +111,7 @@ service Query
*/
interface com::sun::star::sdbcx::XDataDescriptorFactory;
- // DocMerge: empty anyway
+ // allows to rename the object.
interface com::sun::star::sdbcx::XRename;
@@ -125,6 +127,15 @@ service Query
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.2.2 2002/02/18 12:53:58 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4.2.1 2002/02/18 10:25:59 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/QueryDefinition.idl b/offapi/com/sun/star/sdb/QueryDefinition.idl
index 294ffaa1e..f408b9036 100644
--- a/offapi/com/sun/star/sdb/QueryDefinition.idl
+++ b/offapi/com/sun/star/sdb/QueryDefinition.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: QueryDefinition.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:34 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -71,7 +71,9 @@
// DocMerge from xml: service com::sun::star::sdb::QueryDefinition
/** is a stored definition of a SQL "Select statement".
- <p>It can be used, if there is a need to execute SQL statement more than once. </p>
+ <p>
+ It can be used, if there is a need to execute SQL statement more than once.
+ </p>
*/
service QueryDefinition
{
@@ -89,7 +91,7 @@ service QueryDefinition
// DocMerge from xml: property com::sun::star::sdb::QueryDefinition::Command
- /** is the command of the query, this is typically a Select statement.
+ /** is the command of the query, this is typically a select statement.
*/
[property] string Command;
@@ -125,6 +127,12 @@ service QueryDefinition
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.2.1 2002/02/18 10:22:11 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/QueryDescriptor.idl b/offapi/com/sun/star/sdb/QueryDescriptor.idl
index 09c7e67db..453f27ce3 100644
--- a/offapi/com/sun/star/sdb/QueryDescriptor.idl
+++ b/offapi/com/sun/star/sdb/QueryDescriptor.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: QueryDescriptor.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:34 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -78,11 +78,13 @@ interface XColumnsSupplier;
// DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor
-/** A query is a stored definition of a SQL "Select statement".
+/** is a stored definition of a SQL "Select statement".
- <p>It can be used, if there is a need to execute SQL statement more than once or
+ <p>
+ It can be used, if there is a need to execute SQL statement more than once or
if you want to format the query result fields different from the
- underlying table definitions.</p>
+ underlying table definitions.
+ </p>
*/
service QueryDescriptor
{
@@ -109,7 +111,7 @@ service QueryDescriptor
// DocMerge from xml: property com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor::Command
- /** is the command of the query, this is typically a Select statement.
+ /** is the command of the query, this is typically a select statement.
*/
[property] string Command;
@@ -145,6 +147,12 @@ service QueryDescriptor
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.2.1 2002/02/18 10:26:26 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/ResultColumn.idl b/offapi/com/sun/star/sdb/ResultColumn.idl
index 66985d89b..195488876 100644
--- a/offapi/com/sun/star/sdb/ResultColumn.idl
+++ b/offapi/com/sun/star/sdb/ResultColumn.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: ResultColumn.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:34 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -138,7 +138,8 @@ service ResultColumn
// DocMerge from xml: property com::sun::star::sdb::ResultColumn::ServiceName
/** returns the fully-qualified name of the service whose instances
- are manufactured if the method <code>ResultSet.getObject</code>
+ are manufactured if the method
+ <method scope="com::sun::star::sdbc">XRow::getObject)=</method>
is called to retrieve a value from the column.
*/
[readonly, property] string ServiceName;
@@ -168,6 +169,12 @@ service ResultColumn
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.2.1 2002/02/18 10:24:23 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/ResultSet.idl b/offapi/com/sun/star/sdb/ResultSet.idl
index 1b3f51d61..4fc7d3908 100644
--- a/offapi/com/sun/star/sdb/ResultSet.idl
+++ b/offapi/com/sun/star/sdb/ResultSet.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: ResultSet.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:34 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -73,7 +73,9 @@ interface XColumnsSupplier;
// DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::ResultSet
-/** extends the sdbcx ResultSet by a more sophisticated access to the result sets
+/** extends the
+ <type scope="com::sun::star::sdbcx">ResultSet</type>
+ by a more sophisticated access to the result sets
data.
*/
service ResultSet
@@ -94,6 +96,12 @@ service ResultSet
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.2.1 2002/02/18 10:25:41 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/RowChangeEvent.idl b/offapi/com/sun/star/sdb/RowChangeEvent.idl
index b499d613e..02001eba2 100644
--- a/offapi/com/sun/star/sdb/RowChangeEvent.idl
+++ b/offapi/com/sun/star/sdb/RowChangeEvent.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: RowChangeEvent.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:43:31 $
+ * 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
@@ -75,7 +75,8 @@ struct RowChangeEvent: com::sun::star::lang::EventObject
{
// DocMerge from xml: field com::sun::star::sdb::RowChangeEvent::Action
- /** indicates the type of change.@see com::sun::star::sdb::RowChangeAction
+ /** indicates the type of change.
+ @see com::sun::star::sdb::RowChangeAction
*/
long Action;
@@ -92,6 +93,12 @@ struct RowChangeEvent: com::sun::star::lang::EventObject
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.3.24.1 2002/02/18 10:24:34 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.3 2000/11/08 12:43:31 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:37 hjs
initial import
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
diff --git a/offapi/com/sun/star/sdb/RowSetVetoException.idl b/offapi/com/sun/star/sdb/RowSetVetoException.idl
index c2d59783f..aa0eec784 100644
--- a/offapi/com/sun/star/sdb/RowSetVetoException.idl
+++ b/offapi/com/sun/star/sdb/RowSetVetoException.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: RowSetVetoException.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:43:31 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:36 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -71,6 +71,7 @@
// DocMerge from xml: exception com::sun::star::sdb::RowSetVetoException
/** is an exception fired whenever a rowset operation was cancelled because of
of a veto of an approved listener.
+ @see com::sun::star::sdb::XRowSetApproveListener
*/
exception RowSetVetoException: com::sun::star::sdbc::SQLException
{
@@ -82,6 +83,12 @@ exception RowSetVetoException: com::sun::star::sdbc::SQLException
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.3.24.1 2002/02/18 10:26:12 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.3 2000/11/08 12:43:31 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:37 hjs
initial import
diff --git a/offapi/com/sun/star/sdb/SQLContext.idl b/offapi/com/sun/star/sdb/SQLContext.idl
index 1b9ccdc6e..e3fd33926 100644
--- a/offapi/com/sun/star/sdb/SQLContext.idl
+++ b/offapi/com/sun/star/sdb/SQLContext.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: SQLContext.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:36 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -70,7 +70,8 @@
// DocMerge from xml: exception com::sun::star::sdb::SQLContext
/** provides special information about the context where a
- <type scope="com::sun::star::sdbc">SQLException</type> occurred. As usual
+ <type scope="com::sun::star::sdbc">SQLException</type>
+ occurred. As usual
for SQLExceptions, several SQLContext-objects may be chained, then the
most recent context is appended to the list's tail.
@@ -81,7 +82,9 @@
exception SQLContext: com::sun::star::sdbc::SQLWarning
{
// DocMerge from xml: field com::sun::star::sdb::SQLContext::Details
- /** provides special info about the details where a <type scope="com::sun::star::sdbc">SQLException</type> occured.
+ /** provides special info about the details where a
+ <type scope="com::sun::star::sdbc">SQLException</type>
+ occured.
As usual for SQLExceptions, several SQLContext-objects may be chained, then the
most recent context is appended to the list's tail
*/
@@ -96,6 +99,12 @@ exception SQLContext: com::sun::star::sdbc::SQLWarning
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.2.1 2002/02/18 10:24:07 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.4 2000/12/19 16:03:41 mi
documentations syntax errors fixed
diff --git a/offapi/com/sun/star/sdb/SQLQueryComposer.idl b/offapi/com/sun/star/sdb/SQLQueryComposer.idl
index 0ac8dff8d..eb8026af2 100644
--- a/offapi/com/sun/star/sdb/SQLQueryComposer.idl
+++ b/offapi/com/sun/star/sdb/SQLQueryComposer.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: SQLQueryComposer.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:36 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -74,12 +74,14 @@ interface XColumnsSupplier;
// DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::SQLQueryComposer
-/** represents a tool for composing SQL Select statements.
+/** represents a tool for composing SQL select statements.
- <p>It hides the complexity of parsing and evaluating SQL Statements and provides
+ <p>
+ It hides the complexity of parsing and evaluating SQL Statements and provides
sophisticated methods for expanding a SQL-Statement with filter and order
- criteria.</p>
+ criteria.
+ </p>
*/
service SQLQueryComposer
{
@@ -108,6 +110,12 @@ service SQLQueryComposer
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.2.1 2002/02/18 10:25:16 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/Table.idl b/offapi/com/sun/star/sdb/Table.idl
index b264c516f..b036aff85 100644
--- a/offapi/com/sun/star/sdb/Table.idl
+++ b/offapi/com/sun/star/sdb/Table.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: Table.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:36 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -73,8 +73,9 @@
// DocMerge from xml: service com::sun::star::sdb::Table
-/** extends the <type scope="com::sun::star::sdbcx">Table</type> with additional
- display information, sorting, and filtering criterias.
+/** extends the service
+ <type scope="com::sun::star::sdbcx">Table</type>
+ with additional display information, sorting, and filtering criterias.
*/
service Table
{
@@ -89,7 +90,8 @@ service Table
// DocMerge from xml: property com::sun::star::sdb::Table::Privileges
- /** indicates the privileges for the table.@see com::sun::star::sdbcx::Privilege
+ /** indicates the privileges for the table.
+ @see com::sun::star::sdbcx::Privilege
*/
[readonly, property] long Privileges;
};
@@ -100,6 +102,12 @@ service Table
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.2.1 2002/02/18 10:21:40 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/TableDescriptor.idl b/offapi/com/sun/star/sdb/TableDescriptor.idl
index e7a1d4fb6..7779dc086 100644
--- a/offapi/com/sun/star/sdb/TableDescriptor.idl
+++ b/offapi/com/sun/star/sdb/TableDescriptor.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: TableDescriptor.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:36 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -73,8 +73,9 @@
// DocMerge from xml: service com::sun::star::sdb::TableDescriptor
-/** extends the <type scope="com::sun::star::sdbcx">TableDescriptor</type> with additional
- display informations, sorting, and filtering criteria.
+/** extends the service
+ <type scope="com::sun::star::sdbcx">TableDescriptor</type>
+ with additional display informations, sorting, and filtering criteria.
*/
service TableDescriptor
{
@@ -94,6 +95,12 @@ service TableDescriptor
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.2.1 2002/02/18 10:25:09 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/XAlterQuery.idl b/offapi/com/sun/star/sdb/XAlterQuery.idl
index 5afdab7c2..798bfb87b 100644
--- a/offapi/com/sun/star/sdb/XAlterQuery.idl
+++ b/offapi/com/sun/star/sdb/XAlterQuery.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XAlterQuery.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:37 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -72,13 +72,19 @@
module com { module sun { module star { module sdb {
// DocMerge from xml: interface com::sun::star::sdb::XAlterQuery
-/** is used for creating and appending new objects to a specific container.
+/** is used to alter the command of a query.
*/
interface XAlterQuery: com::sun::star::uno::XInterface
{
// DocMerge from xml: method com::sun::star::sdb::XAlterQuery::alterCommand
/** is intended to alter the command of a query object.
+ @param command
+ the SQL statement
+ @param useEscapeProcessing
+ <TRUE/> when escape processing should be used
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void alterCommand([in]string command, [in]boolean useEscapeProcessing)
raises (com::sun::star::sdbc::SQLException);
@@ -90,6 +96,12 @@ interface XAlterQuery: com::sun::star::uno::XInterface
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.16.1 2002/02/18 10:24:54 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/03/16 16:41:32 jsc
+ remove interfaceheader with uik and remove [const] in method definitions
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/XBookmarksSupplier.idl b/offapi/com/sun/star/sdb/XBookmarksSupplier.idl
index 6f8cf3d25..fdd73f381 100644
--- a/offapi/com/sun/star/sdb/XBookmarksSupplier.idl
+++ b/offapi/com/sun/star/sdb/XBookmarksSupplier.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XBookmarksSupplier.idl,v $
*
- * $Revision: 1.2 $
+ * $Revision: 1.3 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:37 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -76,15 +76,17 @@
//=============================================================================
-/** provides access to the collection of all bookmarks associated with a data source
+/** provides access to the collection of all bookmarks associated with a data source.
*/
interface XBookmarksSupplier: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** @returns the collection of all bookmarks associated with a data source
- <p>A bookmark is simply a string specifying the location of the
- bookmarked document.</p>
+ <p>
+ A bookmark is simply a string specifying the location of the
+ bookmarked document.
+ </p>
*/
com::sun::star::container::XNameAccess getBookmarks();
@@ -97,6 +99,12 @@ interface XBookmarksSupplier: com::sun::star::uno::XInterface
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.2.2.1 2002/02/18 10:26:57 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.2 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.1 2001/04/26 09:10:51 fs
initial checkin - supply bookmarks associated with a DataSource
diff --git a/offapi/com/sun/star/sdb/XColumn.idl b/offapi/com/sun/star/sdb/XColumn.idl
index a2f954dcc..404d61758 100644
--- a/offapi/com/sun/star/sdb/XColumn.idl
+++ b/offapi/com/sun/star/sdb/XColumn.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XColumn.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:37 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -109,56 +109,93 @@ interface XColumn: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::wasNull
/** reports whether the last column read had a value of SQL NULL.
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.
+ its value and then call
+ <code>wasNull()</code>
+ to see if the value read was SQL NULL.
+ @returns
+ <TRUE/> if so
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
boolean wasNull() raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getString
/** gets the value of a column in the current row as a String.
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
string getString() raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getBoolean
/** gets the value of a column in the current row as boolean.
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
boolean getBoolean() raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getByte
/** gets the value of a column in the current row as a byte.
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
byte getByte() raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getShort
/** gets the value of a column in the current row as a short.
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
short getShort() raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getInt
/** gets the value of a column in the current row as a long.
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
long getInt() raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getLong
/** gets the value of a column in the current row as a hyper.
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
hyper getLong() raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getFloat
/** gets the value of a column in the current row as a float.
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
float getFloat() raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getDouble
/** gets the value of a column in the current row as a double.
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
double getDouble() raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
@@ -167,7 +204,7 @@ interface XColumn: com::sun::star::uno::XInterface
/** gets the value of a column in the current row as a byte array.
The bytes represent the raw values returned by the driver.
@returns the column value;
-if the value is SQL NULL, the result is empty.
+ if the value is SQL NULL, the result is empty.
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
@@ -176,6 +213,10 @@ if the value is SQL NULL, the result is empty.
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getDate
/** gets the value of a column in the current row as a date object.
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
com::sun::star::util::Date getDate()
raises (com::sun::star::sdbc::SQLException);
@@ -183,6 +224,10 @@ if the value is SQL NULL, the result is empty.
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getTime
/** gets the value of a column in the current row as a time object.
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
com::sun::star::util::Time getTime()
raises (com::sun::star::sdbc::SQLException);
@@ -190,6 +235,10 @@ if the value is SQL NULL, the result is empty.
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getTimestamp
/** gets the value of a column in the current row as a datetime object.
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
com::sun::star::util::DateTime getTimestamp()
raises (com::sun::star::sdbc::SQLException);
@@ -206,10 +255,14 @@ if the value is SQL NULL, the result is empty.
<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>
- is called whether there is data
- available or not.
+ 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>
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
com::sun::star::io::XInputStream getBinaryStream()
raises (com::sun::star::sdbc::SQLException);
@@ -225,9 +278,14 @@ if the value is SQL NULL, the result is empty.
<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>
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
com::sun::star::io::XInputStream getCharacterStream()
raises (com::sun::star::sdbc::SQLException);
@@ -235,9 +293,17 @@ if the value is SQL NULL, the result is empty.
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getObject
/** @returns the value of a column in the current row as an object.
- This method uses the given <code>Map</code> object
+ 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 typeMap
+ the type map is used to fetch the correct type
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
any getObject([in]com::sun::star::container::XNameAccess typeMap)
raises (com::sun::star::sdbc::SQLException);
@@ -246,25 +312,40 @@ if the value is SQL NULL, the result is empty.
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getRef
/** gets a REF(&lt;structured-type&gt) column value from the current row.
-<!-- JRH: html changed from "REF(&amp;lt;structured-type&amp;gt;)" -->
-*/
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
+ */
com::sun::star::sdbc::XRef getRef() raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getBlob
/** gets a BLOB (Binary Large OBject) value in the current row.
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
com::sun::star::sdbc::XBlob getBlob() raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getClob
/** gets a CLOB value in the current row of this <code>ResultSet</code> object.
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
com::sun::star::sdbc::XClob getClob() raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getArray
/** gets a SQL ARRAY value from the current row.
+ @returns
+ the column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
com::sun::star::sdbc::XArray getArray() raises (com::sun::star::sdbc::SQLException);
};
@@ -275,6 +356,12 @@ if the value is SQL NULL, the result is empty.
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.2.1 2002/02/18 10:21:46 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.4 2001/03/16 16:41:32 jsc
remove interfaceheader with uik and remove [const] in method definitions
diff --git a/offapi/com/sun/star/sdb/XColumnUpdate.idl b/offapi/com/sun/star/sdb/XColumnUpdate.idl
index 68ba513ec..3a2fd55c8 100644
--- a/offapi/com/sun/star/sdb/XColumnUpdate.idl
+++ b/offapi/com/sun/star/sdb/XColumnUpdate.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XColumnUpdate.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:37 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -96,66 +96,108 @@ interface XColumnUpdate: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateNull
/** gives a nullable column a null value.
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void updateNull() raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateBoolean
/** updates a column with a boolean value.
+ @param x
+ the new column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void updateBoolean([in]boolean x) raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateByte
/** updates a column with a byte value.
+ @param x
+ the new column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void updateByte([in]byte x) raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateShort
/** updates a column with a short value.
+ @param x
+ the new column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void updateShort([in]short x) raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateInt
/** updates a column with a long value.
+ @param x
+ the new column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void updateInt([in]long x) raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateLong
/** updates a column with a hyper value.
+ @param x
+ the new column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void updateLong([in]hyper x) raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateFloat
/** updates a column with a float value.
+ @param x
+ the new column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void updateFloat([in]float x) raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateDouble
- /** updates a column with a Double value.
+ /** updates a column with a double value.
+ @param x
+ the new column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void updateDouble([in]double x) raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateString
- /** updates a column with a String value.
+ /** updates a column with a string value.
+ @param x
+ the new column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void updateString([in]string x) raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateBytes
/** updates a column with a byte array value.
+ @param x
+ the new column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void updateBytes([in]sequence<byte> x) raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateDate
/** updates a column with a Date value.
+ @param x
+ the new column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void updateDate([in]com::sun::star::util::Date x)
raises (com::sun::star::sdbc::SQLException);
@@ -163,6 +205,10 @@ interface XColumnUpdate: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateTime
/** updates a column with a Time value.
+ @param x
+ the new column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void updateTime([in]com::sun::star::util::Time x)
raises (com::sun::star::sdbc::SQLException);
@@ -170,6 +216,10 @@ interface XColumnUpdate: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateTimestamp
/** updates a column with a Timestamp value.
+ @param x
+ the new column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void updateTimestamp([in]com::sun::star::util::DateTime x)
raises (com::sun::star::sdbc::SQLException);
@@ -177,6 +227,10 @@ interface XColumnUpdate: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateBinaryStream
/** updates a column with a stream value.
+ @param x
+ the new column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void updateBinaryStream([in]com::sun::star::io::XInputStream x,
[in]long length) raises (com::sun::star::sdbc::SQLException);
@@ -184,6 +238,12 @@ interface XColumnUpdate: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateCharacterStream
/** updates a column with a stream value.
+ @param x
+ the new column value
+ @param length
+ the length of the stream
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void updateCharacterStream([in]com::sun::star::io::XInputStream x,
[in]long length) raises (com::sun::star::sdbc::SQLException);
@@ -191,6 +251,10 @@ interface XColumnUpdate: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateObject
/** updates a column with an Object value.
+ @param x
+ the new column value
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void updateObject([in]any x)
raises (com::sun::star::sdbc::SQLException);
@@ -198,6 +262,12 @@ interface XColumnUpdate: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateNumericObject
/** updates a column with an Object value.
+ @param x
+ the new column value
+ @param scale
+ the scale
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void updateNumericObject([in]any x, [in]long scale)
raises (com::sun::star::sdbc::SQLException);
@@ -209,6 +279,12 @@ interface XColumnUpdate: com::sun::star::uno::XInterface
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.16.1 2002/02/18 10:25:31 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/03/16 16:41:32 jsc
+ remove interfaceheader with uik and remove [const] in method definitions
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/XCommandPreparation.idl b/offapi/com/sun/star/sdb/XCommandPreparation.idl
index dfea67121..1c1cabead 100644
--- a/offapi/com/sun/star/sdb/XCommandPreparation.idl
+++ b/offapi/com/sun/star/sdb/XCommandPreparation.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XCommandPreparation.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:38 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -75,21 +75,34 @@ interface XPreparedStatement;
// DocMerge from xml: interface com::sun::star::sdbc::com::sun::star::sdb::XCommandPreparation
/** is used for preparation of commands.
- <p> A command could be a table, query, or any kind of SQLstatement
- prepared by the user.</p>
+ <p>
+ A command could be a table, query, or any kind of SQL statement
+ prepared by the user.
+ </p>
*/
interface XCommandPreparation: com::sun::star::uno::XInterface
{
// DocMerge from xml: method com::sun::star::sdbc::com::sun::star::sdb::XCommandPreparation::prepareCommand
- /** 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>
+ @param command
+ the command to be prepared. Any SQL statement.
+ @param commandType
+ kind of the command
+ <type scope="com::sun::star::sdb">CommandType</type>
+ @returns
+ the PreparedStatement object
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
com::sun::star::sdbc::XPreparedStatement prepareCommand([in]string command, [in] long commandType)
raises (com::sun::star::sdbc::SQLException);
@@ -101,6 +114,12 @@ interface XCommandPreparation: com::sun::star::uno::XInterface
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.2.1 2002/02/18 10:25:48 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.4 2001/03/16 16:41:32 jsc
remove interfaceheader with uik and remove [const] in method definitions
diff --git a/offapi/com/sun/star/sdb/XCompletedConnection.idl b/offapi/com/sun/star/sdb/XCompletedConnection.idl
index ba0c30241..d5cc29697 100644
--- a/offapi/com/sun/star/sdb/XCompletedConnection.idl
+++ b/offapi/com/sun/star/sdb/XCompletedConnection.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XCompletedConnection.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:38 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -87,6 +87,12 @@ interface XCompletedConnection: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdbc::com::sun::star::sdb::XCompletedConnection::connectWithCompletion
/** attempts to establish a database connection. If information is missing, such as
a user's password, they are completed by user interaction.
+ @param handler
+ will be asked when more information is needed
+ @returns
+ the Connection object
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
com::sun::star::sdbc::XConnection
connectWithCompletion([in]com::sun::star::task::XInteractionHandler handler)
@@ -99,6 +105,12 @@ interface XCompletedConnection: com::sun::star::uno::XInterface
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.2.1 2002/02/18 10:22:53 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.4 2001/03/16 16:41:32 jsc
remove interfaceheader with uik and remove [const] in method definitions
diff --git a/offapi/com/sun/star/sdb/XCompletedExecution.idl b/offapi/com/sun/star/sdb/XCompletedExecution.idl
index d6f7361e1..6f1ce7cb3 100644
--- a/offapi/com/sun/star/sdb/XCompletedExecution.idl
+++ b/offapi/com/sun/star/sdb/XCompletedExecution.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XCompletedExecution.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:38 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -81,6 +81,10 @@ interface XCompletedExecution: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdb::XCompletedExecution::executeWithCompletion
/** completes necessary information before execution, for example parameter values.
+ @param handler
+ will be asked when more information is needed
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void executeWithCompletion([in]com::sun::star::task::XInteractionHandler handler)
raises (com::sun::star::sdbc::SQLException);
@@ -92,6 +96,12 @@ interface XCompletedExecution: com::sun::star::uno::XInterface
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.2.1 2002/02/18 10:24:46 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.4 2001/03/16 16:41:32 jsc
remove interfaceheader with uik and remove [const] in method definitions
diff --git a/offapi/com/sun/star/sdb/XDatabaseAccess.idl b/offapi/com/sun/star/sdb/XDatabaseAccess.idl
index 4ac7c82ae..7263fe8da 100644
--- a/offapi/com/sun/star/sdb/XDatabaseAccess.idl
+++ b/offapi/com/sun/star/sdb/XDatabaseAccess.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XDatabaseAccess.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:38 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -95,6 +95,8 @@ interface XDatabaseAccess: com::sun::star::sdbc::XDataSource
// DocMerge from xml: method com::sun::star::task::com::sun::star::sdb::XDatabaseAccess::hasConnections
/** indicates that connections already exist.
+ @returns
+ <TRUE/> if so
*/
boolean hasConnections();
//-------------------------------------------------------------------------
@@ -102,6 +104,15 @@ interface XDatabaseAccess: com::sun::star::sdbc::XDataSource
// DocMerge from xml: method com::sun::star::task::com::sun::star::sdb::XDatabaseAccess::getIsolatedConnection
/** attempts to establish a database connection, that can not be shared with
other components. This should be used for transaction processing.
+ @param user
+ the user name
+ @param password
+ the password
+ @returns
+ an isolated connection object
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
+ @see com::sun::star::sdb::XConnection
*/
XConnection getIsolatedConnection([in]string user, [in]string password)
raises (com::sun::star::sdbc::SQLException);
@@ -110,6 +121,8 @@ interface XDatabaseAccess: com::sun::star::sdbc::XDataSource
// DocMerge from xml: method com::sun::star::task::com::sun::star::sdb::XDatabaseAccess::suspendConnections
/** closes the all connections to database. This request could be aborted by
listeners of the component.
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
boolean suspendConnections() raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
@@ -117,12 +130,18 @@ interface XDatabaseAccess: com::sun::star::sdbc::XDataSource
// DocMerge from xml: method com::sun::star::task::com::sun::star::sdb::XDatabaseAccess::addDatabaseAccessListener
/** adds the specified listener to receive the events "connectionChanged",
"approveConnectionClose", and "connectionClosing".
+ @param listener
+ the listener to append
+ @see com::sun::star::sdb::XDatabaseAccessListener
*/
[oneway] void addDatabaseAccessListener([in]XDatabaseAccessListener listener);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::task::com::sun::star::sdb::XDatabaseAccess::removeDatabaseAccessListener
/** removes the specified listener.
+ @param listener
+ the listener to append
+ @see com::sun::star::sdb::XDatabaseAccessListener
*/
[oneway] void removeDatabaseAccessListener(
[in]XDatabaseAccessListener listener);
@@ -135,6 +154,12 @@ interface XDatabaseAccess: com::sun::star::sdbc::XDataSource
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.2.1 2002/02/18 10:24:28 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.4 2001/03/16 16:41:32 jsc
remove interfaceheader with uik and remove [const] in method definitions
diff --git a/offapi/com/sun/star/sdb/XDatabaseAccessListener.idl b/offapi/com/sun/star/sdb/XDatabaseAccessListener.idl
index e2ca55420..2b98dfe22 100644
--- a/offapi/com/sun/star/sdb/XDatabaseAccessListener.idl
+++ b/offapi/com/sun/star/sdb/XDatabaseAccessListener.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XDatabaseAccessListener.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:39 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -73,30 +73,42 @@
"connectionClosing" events posted by a database access bean.
- <p>A database access bean setting may be changed to connect to a different database.
+ <p>
+ A database access bean setting may be changed to connect to a different database.
In that case, the connection of the bean must be closed and a new connection must
be established. The could affect the current data processing on the bean, as it
could be shared by a number of components. To prevent the bean from closing it's
- connection, a DatabaseAccessListener could abort the closing.</p>
+ connection, a DatabaseAccessListener could abort the closing.
+ </p>
*/
interface XDatabaseAccessListener: com::sun::star::lang::XEventListener
{
// DocMerge from xml: method com::sun::star::sdb::XDatabaseAccessListener::connectionChanged
/** indicates that a new connection for the bean has been established.
+ @param evenet
+ the event happend
*/
[oneway] void connectionChanged([in]com::sun::star::lang::EventObject event);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::sdb::XDatabaseAccessListener::approveConnectionClosing
/** indicates that the connection of the bean will be closed. If there are pending
- actions on the connection of the bean, "approveConnectionClosing" should return <FALSE/>.
+ actions on the connection of the bean, "approveConnectionClosing" should return
+ <FALSE/>.
+
+ @param evenet
+ the event happend
+ @returns
+ <TRUE/> when approved, otherwise <FALSE/>
*/
boolean approveConnectionClosing([in]com::sun::star::lang::EventObject event);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::sdb::XDatabaseAccessListener::connectionClosing
/** indicates that the connection will definitely be closed.
+ @param evenet
+ the event happend
*/
[oneway] void connectionClosing([in]com::sun::star::lang::EventObject event);
};
@@ -107,6 +119,12 @@ interface XDatabaseAccessListener: com::sun::star::lang::XEventListener
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.16.1 2002/02/18 10:22:37 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5 2001/03/16 16:41:32 jsc
+ remove interfaceheader with uik and remove [const] in method definitions
+
Revision 1.4 2000/12/14 12:53:38 mi
<true></true> -> <TRUE/> and same with FALSE
diff --git a/offapi/com/sun/star/sdb/XDatabaseEnvironment.idl b/offapi/com/sun/star/sdb/XDatabaseEnvironment.idl
index eef20f616..dc04782aa 100644
--- a/offapi/com/sun/star/sdb/XDatabaseEnvironment.idl
+++ b/offapi/com/sun/star/sdb/XDatabaseEnvironment.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XDatabaseEnvironment.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:39 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -89,6 +89,8 @@ interface XDatabaseAccess;
/** specifies the root of the data access beans. It provides the possiblity
to open a data access bean, which contains tables, queries, forms, and
report documents, or to open a connection to a database.
+
+ @deprecated
*/
interface XDatabaseEnvironment: com::sun::star::sdbc::XDriverManager
{
@@ -101,6 +103,10 @@ interface XDatabaseEnvironment: com::sun::star::sdbc::XDriverManager
<p>Database Access beans are always shared, so if there's a second request
for the same bean, the same instance of the bean will be returned, if it is still alive.
</p>
+ @param URL
+ a database url of the form sdbc:subprotocol:subname
+ @returns
+ the database access object for this url
*/
XDatabaseAccess getDatabaseAccess([in]string URL)
raises (com::sun::star::sdbc::SQLException);
@@ -108,6 +114,12 @@ interface XDatabaseEnvironment: com::sun::star::sdbc::XDriverManager
// DocMerge from xml: method com::sun::star::sdb::XDatabaseEnvironment::createDatabaseAccess
/** creates a new DatabaseAccess bean specified by it's URL.
+ @param URL
+ a database url of the form sdbc:subprotocol:subname
+ @param title
+ the title of the database access
+ @returns
+ the new created database access object for this url
*/
XDatabaseAccess createDatabaseAccess([in]string URL, [in]string title)
raises (com::sun::star::sdbc::SQLException);
@@ -120,6 +132,12 @@ interface XDatabaseEnvironment: com::sun::star::sdbc::XDriverManager
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.2.1 2002/02/18 10:22:22 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.4 2001/03/16 16:41:32 jsc
remove interfaceheader with uik and remove [const] in method definitions
diff --git a/offapi/com/sun/star/sdb/XFormDocumentsSupplier.idl b/offapi/com/sun/star/sdb/XFormDocumentsSupplier.idl
index 03543cd2a..c49dbe120 100644
--- a/offapi/com/sun/star/sdb/XFormDocumentsSupplier.idl
+++ b/offapi/com/sun/star/sdb/XFormDocumentsSupplier.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XFormDocumentsSupplier.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:39 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -80,6 +80,8 @@ interface XFormDocumentsSupplier: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdb::XFormDocumentsSupplier::getFormDocuments
/** returns the container of forms.
+ @returns
+ the form documents
*/
com::sun::star::container::XNameAccess getFormDocuments();
};
@@ -90,6 +92,12 @@ interface XFormDocumentsSupplier: com::sun::star::uno::XInterface
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.16.1 2002/02/18 10:24:12 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/03/16 16:41:32 jsc
+ remove interfaceheader with uik and remove [const] in method definitions
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/XInteractionSupplyParameters.idl b/offapi/com/sun/star/sdb/XInteractionSupplyParameters.idl
index df942a408..129a6b1be 100644
--- a/offapi/com/sun/star/sdb/XInteractionSupplyParameters.idl
+++ b/offapi/com/sun/star/sdb/XInteractionSupplyParameters.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XInteractionSupplyParameters.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:40 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -73,12 +73,16 @@ module com { module sun { module star { module sdb {
/** An interaction continuation handing back parameter data.
- <p>This continuation is typically used in conjunction with a
- <type scope="com.sun.star.sdb">ParametersRequest</type>. </p>
+ <p>
+ This continuation is typically used in conjunction with a
+ <type scope="com.sun.star.sdb">ParametersRequest</type>.
+ </p>
*/
interface XInteractionSupplyParameters: com::sun::star::task::XInteractionContinuation
{
/** set the parameters chosen by the interaction handler
+ @param Values
+ the parameters to set
*/
void setParameters( [in] sequence< com::sun::star::beans::PropertyValue > Values);
};
@@ -89,6 +93,12 @@ interface XInteractionSupplyParameters: com::sun::star::task::XInteractionContin
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.16.1 2002/02/18 10:25:25 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5 2001/03/16 16:41:32 jsc
+ remove interfaceheader with uik and remove [const] in method definitions
+
Revision 1.4 2000/12/15 11:29:29 mi
@desc removed (now <p>...</p>), @desc is not a valid tag
diff --git a/offapi/com/sun/star/sdb/XParametersSupplier.idl b/offapi/com/sun/star/sdb/XParametersSupplier.idl
index fcdb5bb67..8fb91f2e7 100644
--- a/offapi/com/sun/star/sdb/XParametersSupplier.idl
+++ b/offapi/com/sun/star/sdb/XParametersSupplier.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XParametersSupplier.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:40 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -81,6 +81,8 @@ interface XParametersSupplier: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdb::XParametersSupplier::getParameters
/** returns the container of parameters.
+ @returns
+ the parameters
*/
com::sun::star::container::XIndexAccess getParameters();
};
@@ -91,6 +93,12 @@ interface XParametersSupplier: com::sun::star::uno::XInterface
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.16.1 2002/02/18 10:23:50 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/03/16 16:41:32 jsc
+ remove interfaceheader with uik and remove [const] in method definitions
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/XQueriesSupplier.idl b/offapi/com/sun/star/sdb/XQueriesSupplier.idl
index f7fc93f72..f1a43fdc9 100644
--- a/offapi/com/sun/star/sdb/XQueriesSupplier.idl
+++ b/offapi/com/sun/star/sdb/XQueriesSupplier.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XQueriesSupplier.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:40 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -80,6 +80,8 @@ interface XQueriesSupplier: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdb::XQueriesSupplier::getQueries
/** returns the container of queries.
+ @returns
+ the queries
*/
com::sun::star::container::XNameAccess getQueries();
};
@@ -90,6 +92,12 @@ interface XQueriesSupplier: com::sun::star::uno::XInterface
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.16.1 2002/02/18 10:22:49 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/03/16 16:41:32 jsc
+ remove interfaceheader with uik and remove [const] in method definitions
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/XQueryDefinitionsSupplier.idl b/offapi/com/sun/star/sdb/XQueryDefinitionsSupplier.idl
index 67be656af..7a3d2444f 100644
--- a/offapi/com/sun/star/sdb/XQueryDefinitionsSupplier.idl
+++ b/offapi/com/sun/star/sdb/XQueryDefinitionsSupplier.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XQueryDefinitionsSupplier.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:40 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -80,6 +80,8 @@ interface XQueryDefinitionsSupplier: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdb::XQueryDefinitionsSupplier::getQueryDefinitions
/** returns the container of commands.
+ @returns
+ the query definitions
*/
com::sun::star::container::XNameAccess getQueryDefinitions();
};
@@ -90,6 +92,12 @@ interface XQueryDefinitionsSupplier: com::sun::star::uno::XInterface
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.16.1 2002/02/18 10:28:04 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/03/16 16:41:32 jsc
+ remove interfaceheader with uik and remove [const] in method definitions
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/XReportDocumentsSupplier.idl b/offapi/com/sun/star/sdb/XReportDocumentsSupplier.idl
index 61e1ba803..c845e38b5 100644
--- a/offapi/com/sun/star/sdb/XReportDocumentsSupplier.idl
+++ b/offapi/com/sun/star/sdb/XReportDocumentsSupplier.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XReportDocumentsSupplier.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:40 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -80,6 +80,8 @@ interface XReportDocumentsSupplier: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdb::XReportDocumentsSupplier::getReportDocuments
/** returns the container of reports.
+ @returns
+ the report documents
*/
com::sun::star::container::XNameAccess getReportDocuments();
};
@@ -90,6 +92,12 @@ interface XReportDocumentsSupplier: com::sun::star::uno::XInterface
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.16.1 2002/02/18 10:27:56 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/03/16 16:41:32 jsc
+ remove interfaceheader with uik and remove [const] in method definitions
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/XResultSetAccess.idl b/offapi/com/sun/star/sdb/XResultSetAccess.idl
index 9b396c3d5..92afdf384 100644
--- a/offapi/com/sun/star/sdb/XResultSetAccess.idl
+++ b/offapi/com/sun/star/sdb/XResultSetAccess.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XResultSetAccess.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:41 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -80,13 +80,19 @@ interface XResultSet;
// DocMerge from xml: interface com::sun::star::sdbc::com::sun::star::sdb::XResultSetAccess
-/** is the interface to create a ResultSet based on the object providing the interface.
+/** is the interface to create a
+ <type scope="com::sun::star::sdbc">ResultSet</type>
+ based on the object providing the interface.
*/
interface XResultSetAccess: com::sun::star::uno::XInterface
{
// DocMerge from xml: method com::sun::star::sdbc::com::sun::star::sdb::XResultSetAccess::createResultSet
- /** returns a new ResultSet based on the object.
+ /** returns a new
+ <type scope="com::sun::star::sdbc">ResultSet</type>
+ based on the object.
+ @returns
+ the new created ResultSet object
*/
com::sun::star::sdbc::XResultSet createResultSet() raises (com::sun::star::sdbc::SQLException);
};
@@ -97,6 +103,12 @@ interface XResultSetAccess: com::sun::star::uno::XInterface
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.2.1 2002/02/18 10:27:50 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.4 2001/03/16 16:41:32 jsc
remove interfaceheader with uik and remove [const] in method definitions
diff --git a/offapi/com/sun/star/sdb/XRowSetApproveBroadcaster.idl b/offapi/com/sun/star/sdb/XRowSetApproveBroadcaster.idl
index 71e16b635..60bef1334 100644
--- a/offapi/com/sun/star/sdb/XRowSetApproveBroadcaster.idl
+++ b/offapi/com/sun/star/sdb/XRowSetApproveBroadcaster.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XRowSetApproveBroadcaster.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:41 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -80,6 +80,7 @@ interface XRowSetApproveBroadcaster: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdb::XRowSetApproveBroadcaster::addRowSetApproveListener
/** adds the specified listener to receive the events "approveCursorMove",
"approveRowChange", and "appproveRowSetChange".
+ @param com::sun::star::sdb::XRowSetApproveListener
*/
[oneway] void addRowSetApproveListener(
[in]XRowSetApproveListener listener );
@@ -87,6 +88,7 @@ interface XRowSetApproveBroadcaster: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdb::XRowSetApproveBroadcaster::removeRowSetApproveListener
/** removes the specified listener.
+ @param com::sun::star::sdb::XRowSetApproveListener
*/
[oneway] void removeRowSetApproveListener(
[in]XRowSetApproveListener listener );
@@ -98,6 +100,12 @@ interface XRowSetApproveBroadcaster: com::sun::star::uno::XInterface
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.2.1 2002/02/18 10:24:17 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.4 2001/03/16 16:41:32 jsc
remove interfaceheader with uik and remove [const] in method definitions
diff --git a/offapi/com/sun/star/sdb/XRowSetApproveListener.idl b/offapi/com/sun/star/sdb/XRowSetApproveListener.idl
index 1005ac5a5..86020d6e6 100644
--- a/offapi/com/sun/star/sdb/XRowSetApproveListener.idl
+++ b/offapi/com/sun/star/sdb/XRowSetApproveListener.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XRowSetApproveListener.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:41 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -80,12 +80,18 @@ interface XRowSetApproveListener: com::sun::star::lang::XEventListener
// DocMerge from xml: method com::sun::star::sdb::XRowSetApproveListener::approveCursorMove
/** is called before a rowset's cursor is moved.
+ @param event
+ the event which happend
+ @returns <TRUE/> when moving is allowed, otherwise <FALSE/>
*/
boolean approveCursorMove([in]com::sun::star::lang::EventObject event);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::sdb::XRowSetApproveListener::approveRowChange
/** is called before a row is inserted, updated, or deleted.
+ @param event
+ the event which happend
+ @returns <TRUE/> when changing is allowed, otherwise <FALSE/>
*/
boolean approveRowChange([in]RowChangeEvent event);
//-------------------------------------------------------------------------
@@ -93,8 +99,10 @@ interface XRowSetApproveListener: com::sun::star::lang::XEventListener
// DocMerge from xml: method com::sun::star::sdb::XRowSetApproveListener::approveRowSetChange
/** is called before a rowset is changed, or in other words
before a rowset is reexecuted.
-
-<!-- JRH: check that sense is correct. -->*/
+ @param event
+ the event which happend
+ @returns <TRUE/> when changing is allowed, otherwise <FALSE/>
+ */
boolean approveRowSetChange([in]com::sun::star::lang::EventObject event);
};
@@ -104,6 +112,12 @@ interface XRowSetApproveListener: com::sun::star::lang::XEventListener
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.2.1 2002/02/18 10:27:43 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.4 2001/03/16 16:41:32 jsc
remove interfaceheader with uik and remove [const] in method definitions
diff --git a/offapi/com/sun/star/sdb/XRowSetSupplier.idl b/offapi/com/sun/star/sdb/XRowSetSupplier.idl
index 1fa744c83..d23e1fefe 100644
--- a/offapi/com/sun/star/sdb/XRowSetSupplier.idl
+++ b/offapi/com/sun/star/sdb/XRowSetSupplier.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XRowSetSupplier.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:41 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -82,6 +82,8 @@ interface XRowSetSupplier: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdb::XRowSetSupplier::getRowSet
/** provides access to the data source.
+ @returns
+ the RowSet object
*/
com::sun::star::sdbc::XRowSet getRowSet();
@@ -89,6 +91,8 @@ interface XRowSetSupplier: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdb::XRowSetSupplier::setRowSet
/** sets the data source.
+ @param xDataSource
+ the RowSet object to set
*/
[oneway] void setRowSet( [in] com::sun::star::sdbc::XRowSet xDataSource );
@@ -102,6 +106,12 @@ interface XRowSetSupplier: com::sun::star::uno::XInterface
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.16.1 2002/02/18 10:27:35 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/03/16 16:41:32 jsc
+ remove interfaceheader with uik and remove [const] in method definitions
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/XSQLErrorBroadcaster.idl b/offapi/com/sun/star/sdb/XSQLErrorBroadcaster.idl
index 59b491815..15e8b4944 100644
--- a/offapi/com/sun/star/sdb/XSQLErrorBroadcaster.idl
+++ b/offapi/com/sun/star/sdb/XSQLErrorBroadcaster.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XSQLErrorBroadcaster.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:41 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -74,14 +74,16 @@
// DocMerge from xml: interface com::sun::star::sdb::XSQLErrorBroadcaster
/** interface for notifying potential listeners
- of <type scope="com::sun::star::sdbc">SQLException</type>s posted by
- any database object.
+ of
+ <type scope="com::sun::star::sdbc">SQLException</type>
+ s posted by any database object.
*/
interface XSQLErrorBroadcaster: com::sun::star::uno::XInterface
{
// DocMerge from xml: method com::sun::star::sdb::XSQLErrorBroadcaster::addSQLErrorListener
/** adds the specified listener to receive the event "errorOccured"
+ @param com::sun::star::sdb::XSQLErrorListener
*/
[oneway] void addSQLErrorListener(
[in]XSQLErrorListener _rListener );
@@ -89,6 +91,7 @@ interface XSQLErrorBroadcaster: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdb::XSQLErrorBroadcaster::removeSQLErrorListener
/** removes the specified listener.
+ @param com::sun::star::sdb::XSQLErrorListener
*/
[oneway] void removeSQLErrorListener(
[in]XSQLErrorListener _rListener );
@@ -102,6 +105,12 @@ interface XSQLErrorBroadcaster: com::sun::star::uno::XInterface
#endif
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.16.1 2002/02/18 10:27:26 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/03/16 16:41:32 jsc
+ remove interfaceheader with uik and remove [const] in method definitions
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/XSQLErrorListener.idl b/offapi/com/sun/star/sdb/XSQLErrorListener.idl
index 10b7fde65..97bda5ce0 100644
--- a/offapi/com/sun/star/sdb/XSQLErrorListener.idl
+++ b/offapi/com/sun/star/sdb/XSQLErrorListener.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XSQLErrorListener.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:42 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -80,8 +80,11 @@ interface XSQLErrorListener: com::sun::star::lang::XEventListener
{
// DocMerge from xml: method com::sun::star::sdb::XSQLErrorListener::errorOccured
- /** invoked when a database error occurs, just before a SQLException
+ /** invoked when a database error occurs, just before a
+ <type scope="com::sun::star::sdbc">SQLException</type>
is thrown to the application.
+ @param aEvent
+ the event which occured
*/
void errorOccured([in]com::sun::star::sdb::SQLErrorEvent aEvent);
};
@@ -92,6 +95,12 @@ interface XSQLErrorListener: com::sun::star::lang::XEventListener
/*===========================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.16.1 2002/02/18 10:27:18 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/03/16 16:41:32 jsc
+ remove interfaceheader with uik and remove [const] in method definitions
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
diff --git a/offapi/com/sun/star/sdb/XSQLQueryComposer.idl b/offapi/com/sun/star/sdb/XSQLQueryComposer.idl
index 8e3aceb78..c561a5890 100644
--- a/offapi/com/sun/star/sdb/XSQLQueryComposer.idl
+++ b/offapi/com/sun/star/sdb/XSQLQueryComposer.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XSQLQueryComposer.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:42 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -80,17 +80,20 @@
//=============================================================================
// DocMerge from xml: interface com::sun::star::sdb::XSQLQueryComposer
-/** should be provided by a tool which simplifies the handling with SQL SELECT statements.
+/** should be provided by a tool which simplifies the handling with SQL select statements.
-
- <p>The interface can be used for composing SELECT statements without knowing the
- structure of the used query.</p>
+ <p>
+ The interface can be used for composing SELECT statements without knowing the
+ structure of the used query.
+ </p>
*/
interface XSQLQueryComposer: com::sun::star::uno::XInterface
{
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::getQuery
/** returns the query used for composing.
+ @returns
+ the query
*/
string getQuery();
//-------------------------------------------------------------------------
@@ -98,6 +101,10 @@ interface XSQLQueryComposer: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::setQuery
/** sets a new query for the composer, which may be expanded by filters
and sort criteria.
+ @param command
+ the command to set
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void setQuery([in] string command )
raises (com::sun::star::sdbc::SQLException);
@@ -105,6 +112,8 @@ interface XSQLQueryComposer: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::getComposedQuery
/** returns the query composed with filters and sort criterias.
+ @returns
+ the composed query
*/
string getComposedQuery();
//-------------------------------------------------------------------------
@@ -112,19 +121,26 @@ interface XSQLQueryComposer: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::getFilter
/** returns the currently used filter.
-
- <p>The filter criteria returned is part of the where condition of the
- select command, but it does not contain the where token.</p>
+ <p>
+ The filter criteria returned is part of the where condition of the
+ select command, but it does not contain the where token.
+ </p>
+ @returns
+ the filter
*/
string getFilter();
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::sdb::XSQLQueryComposer::getStructuredFilter
/** returns the currently used filter.
- <p>The filter criteria is split into levels. Each level represents the
- OR criterias. Within each level, the Filters are provided as an AND criteria
+ <p>
+ The filter criteria is split into levels. Each level represents the
+ OR criterias. Within each level, the filters are provided as an AND criteria
with the name of the column and the filter condition. The filter condition
is of type string.
+ </p>
+ @returns
+ the structured filter
*/
sequence< sequence<com::sun::star::beans::PropertyValue> >
getStructuredFilter();
@@ -134,15 +150,24 @@ interface XSQLQueryComposer: com::sun::star::uno::XInterface
/** returns the currently used sort order.
- <p>The order criteria returned is part of the ORDER BY clause of the
- select command, but it does not contain the ORDER BY keyword .</p>
+ <p>
+ The order criteria returned is part of the ORDER BY clause of the
+ select command, but it does not contain the ORDER BY keyword .
+ </p>
+ @returns
+ the order
*/
string getOrder();
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::appendFilterByColumn
- /** appends a new filter condition by a <type>DataColumn</type> providing
- the name and the value for the filter.
+ /** appends a new filter condition by a
+ <type scope="com::sun::star::sdb">DataColumn</type>
+ providing the name and the value for the filter.
+ @param column
+ the column which is used to create a filter
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void appendFilterByColumn([in] com::sun::star::beans::XPropertySet column)
raises (com::sun::star::sdbc::SQLException);
@@ -151,6 +176,12 @@ interface XSQLQueryComposer: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::appendOrderByColumn
/** appends an additional part to the sort order criteria of the select
statement.
+ @param column
+ the column which is used to create a order part
+ @param ascending
+ <TRUE/> when the order should be ascending, otherwise <FALSE/>
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void appendOrderByColumn([in] com::sun::star::beans::XPropertySet column,
[in] boolean ascending)
@@ -159,6 +190,10 @@ interface XSQLQueryComposer: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::setFilter
/** makes it possible to set a filter condition for the query.
+ @param filter
+ the filter to set
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void setFilter([in] string filter)
raises (com::sun::star::sdbc::SQLException);
@@ -166,6 +201,10 @@ interface XSQLQueryComposer: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::setOrder
/** makes it possibile to set a sort condition for the query.
+ @param order
+ the order part to set
+ @throws com::sun::star::sdbc::SQLException
+ if a database access error occurs.
*/
void setOrder([in] string order)
raises (com::sun::star::sdbc::SQLException);
@@ -178,6 +217,12 @@ interface XSQLQueryComposer: com::sun::star::uno::XInterface
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.2.1 2002/02/18 10:26:19 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.5 2001/10/25 15:00:32 mi
+ proofreading and corrections from Richard Holt
+
Revision 1.4 2001/03/16 16:41:32 jsc
remove interfaceheader with uik and remove [const] in method definitions
diff --git a/offapi/com/sun/star/sdb/XSQLQueryComposerFactory.idl b/offapi/com/sun/star/sdb/XSQLQueryComposerFactory.idl
index 4abfdcdc3..44eb4eeaa 100644
--- a/offapi/com/sun/star/sdb/XSQLQueryComposerFactory.idl
+++ b/offapi/com/sun/star/sdb/XSQLQueryComposerFactory.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XSQLQueryComposerFactory.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:06:42 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -71,13 +71,17 @@
//=============================================================================
// DocMerge from xml: interface com::sun::star::sdb::XSQLQueryComposerFactory
-/** is a factory for instances of service <type>SQLQueryComposer</type>.
+/** is a factory for instances of service
+ <type scope="com::sun::star::sdb">SQLQueryComposer</type>
+ .
*/
interface XSQLQueryComposerFactory: com::sun::star::uno::XInterface
{
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposerFactory::createQueryComposer
/** creates a new query composer.
+ @returns
+ the SQLQueryComposer object
*/
com::sun::star::sdb::XSQLQueryComposer createQueryComposer();
};
@@ -89,6 +93,12 @@ interface XSQLQueryComposerFactory: com::sun::star::uno::XInterface
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4.16.1 2002/02/18 10:25:01 oj
+ #97563# parameter,return value and exception description
+
+ Revision 1.4 2001/03/16 16:41:32 jsc
+ remove interfaceheader with uik and remove [const] in method definitions
+
Revision 1.3 2000/11/08 12:43:31 mi
moved from api