diff options
Diffstat (limited to 'offapi/com/sun/star/sdb')
47 files changed, 164 insertions, 164 deletions
diff --git a/offapi/com/sun/star/sdb/CallableStatement.idl b/offapi/com/sun/star/sdb/CallableStatement.idl index e4ec9ed1f05d..6db7f0f669d0 100644 --- a/offapi/com/sun/star/sdb/CallableStatement.idl +++ b/offapi/com/sun/star/sdb/CallableStatement.idl @@ -28,7 +28,7 @@ /** 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> + com::sun::star::sdbc::CallableStatement . */ published service CallableStatement diff --git a/offapi/com/sun/star/sdb/ColumnSettings.idl b/offapi/com/sun/star/sdb/ColumnSettings.idl index c476a8e06494..3c0a45a760f2 100644 --- a/offapi/com/sun/star/sdb/ColumnSettings.idl +++ b/offapi/com/sun/star/sdb/ColumnSettings.idl @@ -35,7 +35,7 @@ published service ColumnSettings column. <p>The proper value can be determined by using the - <type scope="com::sun::star::util">XNumberFormatter</type> + com::sun::star::util::XNumberFormatter interface. </p> <p> diff --git a/offapi/com/sun/star/sdb/Connection.idl b/offapi/com/sun/star/sdb/Connection.idl index e3b5407b991f..e4232d28b2a3 100644 --- a/offapi/com/sun/star/sdb/Connection.idl +++ b/offapi/com/sun/star/sdb/Connection.idl @@ -38,7 +38,7 @@ module com { module sun { module star { module lang { module application { interface XTableUIProvider; }; /** extends the - <type scope="com::sun::star::sdbc">Connection</type> + com::sun::star::sdbc::Connection of SDBC by providing the data definitions of a connected database. */ published service Connection diff --git a/offapi/com/sun/star/sdb/ContentLoader.idl b/offapi/com/sun/star/sdb/ContentLoader.idl index 1d8c23fc0634..75ec45e7b70a 100644 --- a/offapi/com/sun/star/sdb/ContentLoader.idl +++ b/offapi/com/sun/star/sdb/ContentLoader.idl @@ -28,7 +28,7 @@ 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, use an instance with - the <type scope="com::sun::star::frame">XComponentLoader</type> interface, and pass + the com::sun::star::frame::XComponentLoader interface, and pass one of the below-mentioned URLs to it.</p> @see com::sun::star::frame::XComponentLoader @@ -51,27 +51,27 @@ published service ContentLoader <ul> <li><b>.component:DB/DataSourceBrowser</b><br/> Using this URL creates an instance of the - <type scope="com::sun::star::sdb">DataSourceBrowser</type> + com::sun::star::sdb::DataSourceBrowser 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 - <type scope="com::sun::star::sdb">ExternalSourceBrowser</type> + com::sun::star::sdb::ExternalSourceBrowser service and plugs it into the frame passed to the loader. </li> <li><b>.component:DB/QueryDesign</b><br/> Using this URL creates an instance of the - <type scope="com::sun::star::sdb">QueryDesign</type> + com::sun::star::sdb::QueryDesign service and plugs it into the frame passed to the loader. </li> <li><b>.component:DB/TableDesign</b><br/> Using this URL creates an instance of the - <type scope="com::sun::star::sdb">TableDesign</type> + com::sun::star::sdb::TableDesign service and plugs it into the frame passed to the loader. </li> <li><b>.component:DB/RelationDesign</b><br/> Using this URL creates an instance of the - <type scope="com::sun::star::sdb">RelationDesign</type> + com::sun::star::sdb::RelationDesign service and plugs it into the frame passed to the loader. </li> </ul> @@ -80,7 +80,7 @@ published service ContentLoader <member scope="com::sun::star::frame">XFrameLoader::load()</member> are forwarded to the object being created, in particular to it's - <type scope="com::sun::star::lang">XInitialization</type> + com::sun::star::lang::XInitialization interface. **/ service com::sun::star::frame::FrameLoader; diff --git a/offapi/com/sun/star/sdb/DataAccessDescriptor.idl b/offapi/com/sun/star/sdb/DataAccessDescriptor.idl index 066894d750c5..92a85c48e70b 100644 --- a/offapi/com/sun/star/sdb/DataAccessDescriptor.idl +++ b/offapi/com/sun/star/sdb/DataAccessDescriptor.idl @@ -88,7 +88,7 @@ published service DataAccessDescriptor /** is a connection to use. - <p>This object is guaranteed to be a <type scope="com::sun::star::sdbc">Connection</type>, but usually + <p>This object is guaranteed to be a com::sun::star::sdbc::Connection, but usually it will be a Connection from the module com::sun::star::sdb.<br/> Especially in the case where no <member>DataSourceName</member> is given, but <member>CommandType</member> is <member>CommandType::QUERY</member>, the ActiveConnection needs @@ -180,13 +180,13 @@ published service DataAccessDescriptor has access to an already existent result set, it can pass it along for reusage. This is encouraged to increase performance.</p> - <p>The object will at least support the <type scope="com::sun::star::sdbc">ResultSet</type> service.</p> + <p>The object will at least support the com::sun::star::sdbc::ResultSet service.</p> - <p>Note that any superservices of <type scope="com::sun::star::sdbc">ResultSet</type> + <p>Note that any superservices of com::sun::star::sdbc::ResultSet are also allowed. Especially, this member can denote an instance of the - <type scope="com::sun::star::sdb">RowSet</type>, or an instance obtained + com::sun::star::sdb::RowSet, or an instance obtained by calling <member scope="com::sun::star::sdb">XResultSetAccess::createResultSet</member> - on such a <type scope="com::sun::star::sdb">RowSet</type>. This becomes important in + on such a com::sun::star::sdb::RowSet. This becomes important in conjunction with the <member>Selection</member> property.</p> @see com::sun::star::sdb::XResultSetAccess @@ -207,7 +207,7 @@ published service DataAccessDescriptor <member>BookmarkSelection</member> becomes mandatory.</p> <p>If the elements specify bookmarks, and a <member>ResultSet</member> has been specified, then - this result set is required to support the <type scope="com::sun::star::sdbcx">XRowLocate</type> interface.</p> + this result set is required to support the com::sun::star::sdbcx::XRowLocate interface.</p> */ [optional, property] sequence< any > Selection; @@ -240,7 +240,7 @@ published service DataAccessDescriptor used to describe a column object can pass this object directly, instead of specifying it only implicitly with the <member>ColumnName</member> property.</p> - <p>The object will at least support the <type scope="com::sun::star::sdbcx">Column</type> service, but more + <p>The object will at least support the com::sun::star::sdbcx::Column service, but more often it will even be a Column from the com::sun::star::sdb module.</p> */ [optional, property] com::sun::star::beans::XPropertySet Column; diff --git a/offapi/com/sun/star/sdb/DataSettings.idl b/offapi/com/sun/star/sdb/DataSettings.idl index 04d25b8a8ddd..950e4e4c7c6b 100644 --- a/offapi/com/sun/star/sdb/DataSettings.idl +++ b/offapi/com/sun/star/sdb/DataSettings.idl @@ -28,7 +28,7 @@ /** extends the - <type scope="com::sun::star::sdbcx">Table</type> + com::sun::star::sdbcx::Table with additional display information, sorting and filtering criteria. */ diff --git a/offapi/com/sun/star/sdb/DataSource.idl b/offapi/com/sun/star/sdb/DataSource.idl index 6944d7604551..61d9742a899e 100644 --- a/offapi/com/sun/star/sdb/DataSource.idl +++ b/offapi/com/sun/star/sdb/DataSource.idl @@ -44,7 +44,7 @@ /** is a factory to establish database connections. It should be registered at - a <type scope="com::sun::star::uno">NamingService</type>. + a com::sun::star::uno::NamingService. @see com::sun::star::sdb::DatabaseContext */ published service DataSource @@ -58,7 +58,7 @@ published service DataSource interface XCompletedConnection; /** useful for establishing isolated connections which are not shared among others - as it is the case when using XCompletedConnection or <type scope="com::sun::star::sdbc">XDataSource</type>. + as it is the case when using XCompletedConnection or com::sun::star::sdbc::XDataSource. @see XCompletedConnection @see com::sun::star::sdbc::XDataSource @since OOo 1.1.2 @@ -76,7 +76,7 @@ published service DataSource The object returned by the <method scope="com::sun::star::sdb">XQueryDefinitionsSupplier::getQueryDefinitions()</method> supports the - <type scope="com::sun::star::sdb">DefinitionContainer</type> + com::sun::star::sdb::DefinitionContainer service. </p> */ @@ -91,7 +91,7 @@ published service DataSource The object returned by the <method scope="com::sun::star::sdb">XBookmarksSupplier::getBookmarks()</method> supports the - <type scope="com::sun::star::sdb">DefinitionContainer</type> + com::sun::star::sdb::DefinitionContainer service. </p> */ @@ -123,7 +123,7 @@ published service DataSource <p>Instead, the values in this property have two use cases: <ul><li>Upon creating a connection, for every value in this sequence it's checked - whether the <type scope="com::sun::star::sdbc">XDriver</type> which is to provide + whether the com::sun::star::sdbc::XDriver which is to provide the connection supports a setting with the respective name, using its <member scope="com::sun::star::sdbc">XDriver::getPropertyInfo<member> method.br/> If so, the settings is passed to the driver's @@ -146,11 +146,11 @@ published service DataSource <p>You should use the <member>Setting</member> property if you need to access a few properties only, and the <member>Info</member> property if you need access to all existent settings at once.</p> - <p>The object represented by this property supports the <type scope="com::sun::star::beans">PropertyBag</type> + <p>The object represented by this property supports the com::sun::star::beans::PropertyBag service. That is, you can at runtime add arbitrary new properties to the bag.</p> <p>Additionally, the property bag supports default values of properties, and thus the - <type scope="com::sun::star::beans">XPropertyState</type> interface. If you add an own property to + com::sun::star::beans::XPropertyState interface. If you add an own property to the bag using <member scope="com::sun::star::beans">XPropertyContainer::addProperty</member>, you need to specify an initial value, which is also used as default value (exceptions see below).</p> diff --git a/offapi/com/sun/star/sdb/DataSourceBrowser.idl b/offapi/com/sun/star/sdb/DataSourceBrowser.idl index 8cab0c7c8d9b..541ae12a6fd9 100644 --- a/offapi/com/sun/star/sdb/DataSourceBrowser.idl +++ b/offapi/com/sun/star/sdb/DataSourceBrowser.idl @@ -66,12 +66,12 @@ module com { module sun { module star { module sdb { >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> + com::sun::star::frame::XDispatchProvider 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 URLs which an external instance can provide dispatches for (usually by implementing a - <type scope="com::sun::star::frame">XDispatchProviderInterceptor</type> + com::sun::star::frame::XDispatchProviderInterceptor 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, @@ -86,7 +86,7 @@ module com { module sun { module star { module sdb { <li><b>.uno:DataSourceBrowser/InsertColumns</b> <br/> Available whenever an external instance provides a dispatcher ( - <type scope="com::sun::star::frame">XDispatch</type>) + com::sun::star::frame::XDispatch) for this URL. <br/> Enabled, if at least one row in the grid view of a table or query is selected. @@ -98,7 +98,7 @@ module com { module sun { module star { module sdb { <li><b>.uno:DataSourceBrowser/InsertContent</b> <br/> Available whenever an external instance provides a dispatcher( - <type scope="com::sun::star::frame">XDispatch</type> + com::sun::star::frame::XDispatch ) for this URL. <br/> Enabled, if at least one row in the grid view of a table or query is selected. @@ -110,7 +110,7 @@ module com { module sun { module star { module sdb { <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. + com::sun::star::frame::XDispatch) for this URL. <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. @@ -165,14 +165,14 @@ published service DataSourceBrowser <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>, or - instances of <type scope="com::sun::star::beans">NamedValue</type>, where the <code>Name</code> member + have to be instances of com::sun::star::beans::PropertyValue, or + instances of com::sun::star::beans::NamedValue, where the <code>Name</code> member specifies what the parameter controls, with the <code>Value</code> 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 + has to be an com::sun::star::frame::XFrame interface specifying the frame to plug the browser component into.</li> <li><b>DataSourceName</b><br/> @@ -213,7 +213,7 @@ published service DataSourceBrowser <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> + com::sun::star::frame::XDispatch interface, and which allow you to be notified on status changes and to dispatch special requests. </p> @@ -258,7 +258,7 @@ published service DataSourceBrowser <p>The selection supplied by <member scope="com::sun::star::ui">ContextMenuExecuteEvent::Selection</member>, in the event structure passed to the context menu interceptors, actually is a value from the - <type scope="com::sun::star::sdb::application">NamedDatabaseObject</type> group.</p> + com::sun::star::sdb::application::NamedDatabaseObject group.</p> @since OOo 3.0 */ diff --git a/offapi/com/sun/star/sdb/DatabaseAccessConnection.idl b/offapi/com/sun/star/sdb/DatabaseAccessConnection.idl index 2e43eb77f7a7..19375e559d82 100644 --- a/offapi/com/sun/star/sdb/DatabaseAccessConnection.idl +++ b/offapi/com/sun/star/sdb/DatabaseAccessConnection.idl @@ -39,7 +39,7 @@ <p> Implements the service - <type scope="com::sun::star::sdbc">Connection</type> + com::sun::star::sdbc::Connection . 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> diff --git a/offapi/com/sun/star/sdb/DatabaseInteractionHandler.idl b/offapi/com/sun/star/sdb/DatabaseInteractionHandler.idl index 52f1937bf919..bf9da7cd7c3c 100644 --- a/offapi/com/sun/star/sdb/DatabaseInteractionHandler.idl +++ b/offapi/com/sun/star/sdb/DatabaseInteractionHandler.idl @@ -28,24 +28,24 @@ module com { module sun { module star { module sdb { /** describes a service which is able to handle database-related interactions. <p>Usually, you will not instantiate this service directly. Instead, you'll instantiate a generic - <type scope="com::sun::star::task">InteractionHandler</type> service, and pass it your request. Based on + com::sun::star::task::InteractionHandler service, and pass it your request. Based on configuration data, this implementation will decide where to forward the request to.</p> <p>By default, the <code>DatabaseInteractionHandler</code> feels responsible (as per configuration) for the following interaction types: <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>, + The general structure to transport such errors is the com::sun::star::sdbc::SQLException, and if your interaction request supplies such a <code>SQLException</code> (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>parameter requests</b><br/> - If your interaction request supplies an <type scope="com::sun::star::sdb">ParametersRequest</type>, + If your interaction request supplies an com::sun::star::sdb::ParametersRequest, the handler will open a standard dialog asking the user to fill in parameter values. <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 + (com::sun::star::sdb::XInteractionSupplyParameters) as well, so the handler can return the entered information. </li> </ul> diff --git a/offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl b/offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl index 3778b0620d7a..50f9a51cc713 100644 --- a/offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl +++ b/offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl @@ -64,18 +64,18 @@ published service DatasourceAdministrationDialog <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> + com::sun::star::lang::XMultiServiceFactory . </p> <p> You specify a parameter by passing one (or more) - <type scope="com::sun::star::beans">PropertyValue</type> + com::sun::star::beans::PropertyValue 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> + com::sun::star::beans::XPropertySet interface ... <br/> allowed parameters are @@ -85,7 +85,7 @@ published service DatasourceAdministrationDialog If not specified, a default title is used. </li> <li><b>ParentWindow</b><br/> - <type scope="com::sun::star::awt">XWindow</type> + com::sun::star::awt::XWindow describing the parent window to use for the dialog. </li> <li><b>InitialSelection</b><br/> diff --git a/offapi/com/sun/star/sdb/DefinitionContent.idl b/offapi/com/sun/star/sdb/DefinitionContent.idl index 263628ec7095..affca9e9a813 100644 --- a/offapi/com/sun/star/sdb/DefinitionContent.idl +++ b/offapi/com/sun/star/sdb/DefinitionContent.idl @@ -37,7 +37,7 @@ service DefinitionContent /** provides the functionality for treating the object as part of a hierarchy of objects. - <p>The following commands are commonly supported by the <type scope="com::sun::star::ucb">XCommandProcessor</type> + <p>The following commands are commonly supported by the com::sun::star::ucb::XCommandProcessor implementation of a <code>DefinitionContent</code>: <ul> <li><strong>getPropertyValues</strong></li> diff --git a/offapi/com/sun/star/sdb/DocumentContainer.idl b/offapi/com/sun/star/sdb/DocumentContainer.idl index b92add7aff32..954ae0aac959 100644 --- a/offapi/com/sun/star/sdb/DocumentContainer.idl +++ b/offapi/com/sun/star/sdb/DocumentContainer.idl @@ -46,9 +46,9 @@ should be used to create sub document container or form, or report objects.</p> <p>The embedded documents do not support any particular database related service, instead, they're - usual <type scope="com::sun::star::document">OfficeDocument</type>s.<br/> + usual com::sun::star::document::OfficeDocuments.<br/> The only thing worth mentioning here is that they support the - <type scope="com::sun::star::container">XChild</type> interface, whose + com::sun::star::container::XChild interface, whose <member scope="com::sun::star::container">XChild::getParent</member> method can be used to obtain the database document which the embedded document belongs to. </p> @@ -67,7 +67,7 @@ service DocumentContainer of a <code>DocumentDefinition</code> supports at least the following commands, additionally to the ones already supported by the DefinitionContent: <ul> - <li><strong>open</strong>: provides a <type scope="com::sun::star::ucb::">XDynamicResultSet</type> + <li><strong>open</strong>: provides a com::sun::star::ucb::::XDynamicResultSet to enumerate the content of the document container.</li> <li><strong>delete</strong>: deletes the document container, including all contained documents.</li> </ul> diff --git a/offapi/com/sun/star/sdb/DocumentDefinition.idl b/offapi/com/sun/star/sdb/DocumentDefinition.idl index c4f7ca780109..b24bd8f30fda 100644 --- a/offapi/com/sun/star/sdb/DocumentDefinition.idl +++ b/offapi/com/sun/star/sdb/DocumentDefinition.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module sdb { <p>Usual instances of a <code>DocumentDefinition</code> are forms and reports.</p> <p>Note that the <code>DocumentDefinition</code> does not denote the actual document - (i.e. an object supporting the <type scope="com::sun::star::frame">XModel</type> interface), + (i.e. an object supporting the com::sun::star::frame::XModel interface), but only a shortcut to access and load those actual documents.</p> */ service DocumentDefinition @@ -51,7 +51,7 @@ service DocumentDefinition the <code>execute</code> method is the model of the loaded document.</li> <li><strong>preview</strong>: retrieves an image showing a preview of the sub document.</li> <li><strong>getDocumentInfo</strong>: retrieves the document information, as - <type scope="com::sun::star::document">XDocumentProperties</type> + com::sun::star::document::XDocumentProperties instance, of the sub document.</li> <li><strong>delete</strong>: deletes the sub document from the database document.</li> <li><strong>close</strong>: closes the sub document, if it had previously been opened diff --git a/offapi/com/sun/star/sdb/ErrorMessageDialog.idl b/offapi/com/sun/star/sdb/ErrorMessageDialog.idl index bd36735b988d..80c1a9caeb11 100644 --- a/offapi/com/sun/star/sdb/ErrorMessageDialog.idl +++ b/offapi/com/sun/star/sdb/ErrorMessageDialog.idl @@ -42,14 +42,14 @@ module com { module sun { module star { module sdb { </module> , they will - sooner or later - encounter - <type scope="com::sun::star::sdbc">SQLException</type> + com::sun::star::sdbc::SQLException 's. <br/> These exceptions can be chained, so the information wrapped in one single - <type scope="com::sun::star::sdbc">SQLException</type> + com::sun::star::sdbc::SQLException 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> + com::sun::star::sdb::SQLContext to explain what it was doing), and they should be presented to the user in a consistent way. <br/> @@ -63,12 +63,12 @@ published service ErrorMessageDialog : com::sun::star::ui::dialogs::XExecutableD <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> + com::sun::star::lang::XMultiServiceFactory . </p> <p> You specify a parameter by passing one (or more) - <type scope="com::sun::star::beans">PropertyValue</type> + com::sun::star::beans::PropertyValue 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/> @@ -76,7 +76,7 @@ published service ErrorMessageDialog : com::sun::star::ui::dialogs::XExecutableD <method scope="com::sun::star::beans">XPropertySet::setPropertyValue() </method> of the - <type scope="com::sun::star::beans">XPropertySet</type> + com::sun::star::beans::XPropertySet interface ... <br/> allowed parameters are @@ -85,14 +85,14 @@ published service ErrorMessageDialog : com::sun::star::ui::dialogs::XExecutableD 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> + com::sun::star::awt::XWindow describing the parent window to use for the dialog. </li> <li><b>sqlException</b><br/> - <type scope="com::sun::star::sdbc">SQLException</type> + com::sun::star::sdbc::SQLException describing the error which is being displayed.<br/> When initializing this value, you may use any derivative of - <type scope="com::sun::star::sdbc">SQLException</type> + com::sun::star::sdbc::SQLException . </li> </ul> diff --git a/offapi/com/sun/star/sdb/InteractionHandler.idl b/offapi/com/sun/star/sdb/InteractionHandler.idl index 32f7b21bc62d..4b93b778a116 100644 --- a/offapi/com/sun/star/sdb/InteractionHandler.idl +++ b/offapi/com/sun/star/sdb/InteractionHandler.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module sdb { /** is a service for user interaction for databases. @deprecated - Do not use this service anymore. Instead, create a generic <type scope="com::sun::star::task">InteractionHandler</type> + Do not use this service anymore. Instead, create a generic com::sun::star::task::InteractionHandler instance, and pass it your request. It will determine, based on configuration data, which concrete interaction handler implementation to use for a specific request. In particular, requests formerly server by this service here are by default passed to a DatabaseInteractionHandler. diff --git a/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl b/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl index 748eff82f22a..f0c6a02f8b32 100644 --- a/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl +++ b/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl @@ -49,8 +49,8 @@ service OfficeDatabaseDocument { /** specifies basic functionality of a document in OpenOffice.org - <p>Note that a database document actually does not support the <type scope="com::sun::star::view">XPrintable</type> interface. - The non-optional requirement of this interface in the <type scope="com::sun::star::document">OfficeDocument</type> + <p>Note that a database document actually does not support the com::sun::star::view::XPrintable interface. + The non-optional requirement of this interface in the com::sun::star::document::OfficeDocument service is considered a documentation error.</p> */ service com::sun::star::document::OfficeDocument; @@ -213,7 +213,7 @@ service OfficeDatabaseDocument need, they invoke <member scope="com::sun::star::util">XCloseable::close</member>.</p> <p>Since this can be done by multiple clients, every client is additionally required - to register itself as <type scope="com::sun::star::util">XCloseListener</type> at + to register itself as com::sun::star::util::XCloseListener at the document, to prevent some other client closing the model while it's still needed by the first client.</p> */ diff --git a/offapi/com/sun/star/sdb/ParametersRequest.idl b/offapi/com/sun/star/sdb/ParametersRequest.idl index 5aebd58ba63a..9e44f9c50c1d 100644 --- a/offapi/com/sun/star/sdb/ParametersRequest.idl +++ b/offapi/com/sun/star/sdb/ParametersRequest.idl @@ -38,10 +38,10 @@ published exception ParametersRequest: com::sun::star::task::ClassifiedInteracti { /** is the list of parameters requested. The objects returned by the - <type scope="com::sun::star::container">XIndexAccess</type> + com::sun::star::container::XIndexAccess have to be property sets describing the respective parameter. For this, the objects have to support the - service <type scope="com::sun::star::sdbcx">Column</type>. + service com::sun::star::sdbcx::Column. */ com::sun::star::container::XIndexAccess Parameters; diff --git a/offapi/com/sun/star/sdb/PreparedStatement.idl b/offapi/com/sun/star/sdb/PreparedStatement.idl index 7b87bca170a8..7938f1d0217f 100644 --- a/offapi/com/sun/star/sdb/PreparedStatement.idl +++ b/offapi/com/sun/star/sdb/PreparedStatement.idl @@ -30,7 +30,7 @@ /** 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> + com::sun::star::sdbc::PreparedStatement . */ published service PreparedStatement diff --git a/offapi/com/sun/star/sdb/QueryDesign.idl b/offapi/com/sun/star/sdb/QueryDesign.idl index acc7e533f7a9..79ca232f3ec3 100644 --- a/offapi/com/sun/star/sdb/QueryDesign.idl +++ b/offapi/com/sun/star/sdb/QueryDesign.idl @@ -45,7 +45,7 @@ module com { module sun { module star { module sdb { <li><a name="view_mode"</a><b>View Mode</b> <p>In <code>View Mode</code>, the designer is used to modify an existing or create a new server-side view.</p> - <p>The view which is being designed must support the <type scope="com::sun::star::sdbcx">XAlterView</type> + <p>The view which is being designed must support the com::sun::star::sdbcx::XAlterView interface, except when a new view is being designed. In the latter case, the designer closes itself automatically when <code>XAlterView</code> is not supported, and the view has been saved.</p></li> @@ -58,13 +58,13 @@ module com { module sun { module star { module sdb { <h3><a name="initialization"></a>Initialization</h3> - <p>Initialization is done using the <type scope="com::sun::star::lang">XInitialization</type> interface, - which expects a sequence of objects being either <type scope="com::sun::star::beans">NamedValue</type>s or - <type scope="com::sun::star::beans">PropertyValue</type>s. The following parameters are supported at + <p>Initialization is done using the com::sun::star::lang::XInitialization interface, + which expects a sequence of objects being either com::sun::star::beans::NamedValues or + com::sun::star::beans::PropertyValues. The following parameters are supported at initialization time: <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 + has to be an com::sun::star::frame::XFrame interface specifying the frame to plug the QueryDesign component into.<br/> This parameter is mandatory. </li> diff --git a/offapi/com/sun/star/sdb/RelationDesign.idl b/offapi/com/sun/star/sdb/RelationDesign.idl index 3b14141e9262..765c2fec4f3e 100644 --- a/offapi/com/sun/star/sdb/RelationDesign.idl +++ b/offapi/com/sun/star/sdb/RelationDesign.idl @@ -50,14 +50,14 @@ published service RelationDesign <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 + have to be instances of com::sun::star::beans::PropertyValue, 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 + has to be an com::sun::star::frame::XFrame interface specifying the frame to plug the RelationDesign component into. </li> <li><b>DataSourceName</b><br> diff --git a/offapi/com/sun/star/sdb/ResultSet.idl b/offapi/com/sun/star/sdb/ResultSet.idl index f7a97f39fd44..07b9318b431f 100644 --- a/offapi/com/sun/star/sdb/ResultSet.idl +++ b/offapi/com/sun/star/sdb/ResultSet.idl @@ -29,7 +29,7 @@ /** extends the - <type scope="com::sun::star::sdbcx">ResultSet</type> + com::sun::star::sdbcx::ResultSet by a more sophisticated access to the result sets data. */ diff --git a/offapi/com/sun/star/sdb/RowSet.idl b/offapi/com/sun/star/sdb/RowSet.idl index 3c2d1794b93c..e266a44706ac 100644 --- a/offapi/com/sun/star/sdb/RowSet.idl +++ b/offapi/com/sun/star/sdb/RowSet.idl @@ -44,7 +44,7 @@ published interface XParametersSupplier; or a previous instantiated connection. <p> Depending on the - <type scope="com::sun::star::sdbc">ResultSetConcurrency</type> + com::sun::star::sdbc::ResultSetConcurrency , 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. @@ -112,7 +112,7 @@ published interface XParametersSupplier; <td><strong>RowCount</strong></td><td><strong>IsRowCountFinal</strong></td> </tr> - <tr><td><type scope="com::sun::star::sdbc">XResultSet</type></td><td/><td/><td/><td/><td/><td/><td/><td/></tr> + <tr><td>com::sun::star::sdbc::XResultSet</td><td/><td/><td/><td/><td/><td/><td/><td/></tr> <tr><td align="right"><em>next</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td> <tr><td align="right"><em>beforeFirst</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td/><td/></tr> @@ -125,7 +125,7 @@ published interface XParametersSupplier; <tr><td align="right"><em>refreshRow</em></td><td/><td/><td align="center">X</td><td/><td/><td/><td align="center">X</td><td align="center">X</td><td/><td/></tr> <tr><td align="right"><em>cancelRowUpdates</em></td><td/><td/><td align="center">X</td><td/><td/><td/><td align="center">X</td><td/><td/><td/></tr> - <tr><td><type scope="com::sun::star::sdbc">XResultSetUpdate</type></td><td/><td/><td/><td/><td/><td/><td/><td/></tr> + <tr><td>com::sun::star::sdbc::XResultSetUpdate</td><td/><td/><td/><td/><td/><td/><td/><td/></tr> <tr><td align="right"><em>insertRow</em></td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> <tr><td align="right"><em>updateRow</em></td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td/><td/><td/></tr> @@ -133,11 +133,11 @@ published interface XParametersSupplier; <tr><td align="right"><em>moveToInsertRow</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td/><td align="center">X</td><td align="center">X</td></tr> <tr><td align="right"><em>moveToCurrentRow</em></td><td align="center">X</td><td/><td/><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td/><td/></tr> - <tr><td><type scope="com::sun::star::sdbcx">XDeleteRows</type></td><td/><td/><td/><td/><td/><td/><td/><td/></tr> + <tr><td>com::sun::star::sdbcx::XDeleteRows</td><td/><td/><td/><td/><td/><td/><td/><td/></tr> <tr><td align="right"><em>deleteRows</em></td><td/><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> - <tr><td><type scope="com::sun::star::sdbcx">XRowLocate</type></td><td/><td/><td/><td/><td/><td/><td/><td/></tr> + <tr><td>com::sun::star::sdbcx::XRowLocate</td><td/><td/><td/><td/><td/><td/><td/><td/></tr> <tr><td align="right"><em>moveToBookmark</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td/><td/></tr> <tr><td align="right"><em>moveRelativeToBookmark</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> @@ -156,7 +156,7 @@ published interface XParametersSupplier; <dt><member scope="com::sun::star::sdbc">XResultSet::getRow</member></dt> <dd>returns the position of the cursor, which has not been changed by the deletion.</dd> - <dt><type scope="com::sun::star::sdbc">XResultSet</type>: <code>next</code>, <code>first</code>, <code>last</code>, <code>absolute</code>, + <dt>com::sun::star::sdbc::XResultSet: <code>next</code>, <code>first</code>, <code>last</code>, <code>absolute</code>, <code>relative</code>, <code>previous</code>, <code>beforeFirst</code>, <code>afterLast</code></dt> <dd>will let the deleted row vanish from the result set. As a consequence, the <member>RowCount</member> will decrease when you do such a move operation after deleting a row.<br/> @@ -167,13 +167,13 @@ published interface XParametersSupplier; <dt><member scope="com::sun::star::sdbc">XResultSet::refreshRow</member></dt> <dd>will throw an exception when the cursor is on a deleted row.</dd> - <dt><type scope="com::sun::star::sdbc">XRow</type>: <code>getFoo</code></dt> + <dt>com::sun::star::sdbc::XRow: <code>getFoo</code></dt> <dd>will return an empty value when the cursor is on a deleted row.</dd> <dt><member scope="com::sun::star::sdbcx">XRowLocate::getBookmark</member></dt> <dd>will throw an exception when the cursor is on a deleted row.</dd> - <dt><type scope="com::sun::star::sdbc">XRowUpdate</type>: <code>updateFoo</code></dt> + <dt>com::sun::star::sdbc::XRowUpdate: <code>updateFoo</code></dt> <dd>will throw an exception when the cursor is on a deleted row.</dd> <dt><member scope="com::sun::star::sdbc">XResultSetUpdate::deleteRow</member></dt> @@ -197,11 +197,11 @@ published service RowSet /** 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/> + the com::sun::star::sdbc::XParameters interface.<br/> However, you can also choose to let an interaction handler supply such data. For this, you may for instance instantiate an InteractionHandler, which asks the user for the data, or you may write your own one, which supplies the data from somewhere else. - The default implementation will only ask for parameters which aren't set before through the <type scope="com::sun::star::sdbc">XParameters</type> interface.</p> + The default implementation will only ask for parameters which aren't set before through the com::sun::star::sdbc::XParameters interface.</p> @see com::sun::star::sdb::InteractionHandler */ @@ -209,8 +209,8 @@ published service RowSet /** approving of actions performed on the row set. - <p>The support of this interface implies a semantical extension to the <type scope="com::sun::star::sdbc">XResultSetUpdate</type> - interface which is supported via the <type scope="com::sun::star::sdbc">ResultSet</type>.</p> + <p>The support of this interface implies a semantical extension to the com::sun::star::sdbc::XResultSetUpdate + interface which is supported via the com::sun::star::sdbc::ResultSet.</p> @see XResultSetUpdate */ @@ -218,7 +218,7 @@ published service RowSet /** is the interface for updating row data to the database. - <p>The optional support of this interface is already implied with the support of the <type scope="com::sun::star::sdbc">ResultSet</type> service.</p> + <p>The optional support of this interface is already implied with the support of the com::sun::star::sdbc::ResultSet service.</p> <p>However, note that the additional support of the XRowSetApproveBroadcaster interface results in a semantical extension: the methods <member scope="com::sun::star::sdbc">XResultSetUpdate::insertRow</member>, @@ -230,7 +230,7 @@ published service RowSet /** is the interface for deleting more than one row, identified by it's bookmark. - <p>The optional support of this interface is already implied with the support of the <type scope="com::sun::star::sdbcx">ResultSet</type> service.</p> + <p>The optional support of this interface is already implied with the support of the com::sun::star::sdbcx::ResultSet service.</p> <p>However, note that the additional support of the XRowSetApproveBroadcaster interface results in a semantical extension: the method <member scope="com::sun::star::sdbcx">XDeleteRows::deleteRows</member> @@ -259,8 +259,8 @@ published service RowSet using the <code>XParametersSupplier</code> interface.</p> <p>The returned container contains parameter objects which do allow write access to the parameters (which - is equivalent to using the <type scope="com::sun::star::sdbc">XParameters</type> interface inherited from - <type scope="com::sun::star::sdbc">RowSet</type>). Additionally, they provide information about the parameters, + is equivalent to using the com::sun::star::sdbc::XParameters interface inherited from + com::sun::star::sdbc::RowSet). Additionally, they provide information about the parameters, such as their name (if they have one), their type, and the like.</p> */ [optional] interface XParametersSupplier; diff --git a/offapi/com/sun/star/sdb/SQLContext.idl b/offapi/com/sun/star/sdb/SQLContext.idl index 1a5e2ca5fc08..df38b8e23218 100644 --- a/offapi/com/sun/star/sdb/SQLContext.idl +++ b/offapi/com/sun/star/sdb/SQLContext.idl @@ -25,7 +25,7 @@ /** provides special information about the context where a - <type scope="com::sun::star::sdbc">SQLException</type> + com::sun::star::sdbc::SQLException occurred. As usual for SQLExceptions, several SQLContext-objects may be chained, then the most recent context is appended to the list's tail. @@ -37,7 +37,7 @@ published exception SQLContext: com::sun::star::sdbc::SQLWarning { /** provides special info about the details where a - <type scope="com::sun::star::sdbc">SQLException</type> + com::sun::star::sdbc::SQLException occurred. As usual for SQLExceptions, several SQLContext-objects may be chained, then the most recent context is appended to the list's tail diff --git a/offapi/com/sun/star/sdb/SingleSelectQueryComposer.idl b/offapi/com/sun/star/sdb/SingleSelectQueryComposer.idl index a158f0fa5380..bfea134fb671 100644 --- a/offapi/com/sun/star/sdb/SingleSelectQueryComposer.idl +++ b/offapi/com/sun/star/sdb/SingleSelectQueryComposer.idl @@ -30,11 +30,11 @@ interface XSingleSelectQueryComposer; <p> It hides the complexity of parsing and evaluating a single select statement and provides sophisticated methods for expanding a statement with filter, group by, having and order - criteria. To get the new extended statement use the methods from <type scope="com::sun::star::sdb">SingleSelectQueryAnalyzer</type>. + criteria. To get the new extended statement use the methods from com::sun::star::sdb::SingleSelectQueryAnalyzer. </p> <p>A SingleSelectQueryComposer is usually obtained from a Connection - using the <type scope="com::sun::star::lang">XMultiServiceFactory</type> interface.</p> + using the com::sun::star::lang::XMultiServiceFactory interface.</p> */ service SingleSelectQueryComposer { @@ -47,7 +47,7 @@ service SingleSelectQueryComposer interface XSingleSelectQueryComposer; - /** is the original SQL statement set with the interface <type scope="com::sun::star::sdb">XSingleSelectQueryAnalyzer</type>. + /** is the original SQL statement set with the interface com::sun::star::sdb::XSingleSelectQueryAnalyzer. */ [readonly, property] string Original; }; diff --git a/offapi/com/sun/star/sdb/Table.idl b/offapi/com/sun/star/sdb/Table.idl index e825be441905..35eb0879ac5f 100644 --- a/offapi/com/sun/star/sdb/Table.idl +++ b/offapi/com/sun/star/sdb/Table.idl @@ -27,7 +27,7 @@ /** extends the service - <type scope="com::sun::star::sdbcx">Table</type> + com::sun::star::sdbcx::Table with additional display information, sorting, and filtering criteria. */ published service Table diff --git a/offapi/com/sun/star/sdb/TableDescriptor.idl b/offapi/com/sun/star/sdb/TableDescriptor.idl index 12e0ddd95423..03f6a1fde01b 100644 --- a/offapi/com/sun/star/sdb/TableDescriptor.idl +++ b/offapi/com/sun/star/sdb/TableDescriptor.idl @@ -27,7 +27,7 @@ /** extends the service - <type scope="com::sun::star::sdbcx">TableDescriptor</type> + com::sun::star::sdbcx::TableDescriptor with additional display information, sorting, and filtering criteria. */ published service TableDescriptor diff --git a/offapi/com/sun/star/sdb/TableDesign.idl b/offapi/com/sun/star/sdb/TableDesign.idl index 3c615ad65191..46c2231a0852 100644 --- a/offapi/com/sun/star/sdb/TableDesign.idl +++ b/offapi/com/sun/star/sdb/TableDesign.idl @@ -50,14 +50,14 @@ published service TableDesign <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 + have to be instances of com::sun::star::beans::PropertyValue, 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 + has to be an com::sun::star::frame::XFrame interface specifying the frame to plug the TableDesign component into. </li> <li><b>DataSourceName</b><br> diff --git a/offapi/com/sun/star/sdb/XCommandPreparation.idl b/offapi/com/sun/star/sdb/XCommandPreparation.idl index ea4d7c15ad9b..918e5aae726d 100644 --- a/offapi/com/sun/star/sdb/XCommandPreparation.idl +++ b/offapi/com/sun/star/sdb/XCommandPreparation.idl @@ -39,7 +39,7 @@ published interface XCommandPreparation: com::sun::star::uno::XInterface { /** creates a - <type scope="com::sun::star::sdbc">PreparedStatement</type> + com::sun::star::sdbc::PreparedStatement object for sending parameterized SQL statements to the database. <p> @@ -52,7 +52,7 @@ published interface XCommandPreparation: com::sun::star::uno::XInterface the command to be prepared. Any SQL statement. @param commandType kind of the command - <type scope="com::sun::star::sdb">CommandType</type> + com::sun::star::sdb::CommandType @returns the PreparedStatement object @throws com::sun::star::sdbc::SQLException diff --git a/offapi/com/sun/star/sdb/XDocumentDataSource.idl b/offapi/com/sun/star/sdb/XDocumentDataSource.idl index 59e055938263..4d1fc62495f3 100644 --- a/offapi/com/sun/star/sdb/XDocumentDataSource.idl +++ b/offapi/com/sun/star/sdb/XDocumentDataSource.idl @@ -46,7 +46,7 @@ interface XDocumentDataSource on the document as soon as it's not needed anymore.</p> <p>Additionally, if the caller does long-lasting processing on the document, it's advised - to add itself as <type scope="com::sun::star::util">XCloseListener</type> to the document, + to add itself as com::sun::star::util::XCloseListener to the document, to prevent closing as long as the processing lasts.</p> */ [readonly, attribute] XOfficeDatabaseDocument DatabaseDocument; diff --git a/offapi/com/sun/star/sdb/XInteractionDocumentSave.idl b/offapi/com/sun/star/sdb/XInteractionDocumentSave.idl index a01cf6d40adb..0d9b7a20ddd9 100644 --- a/offapi/com/sun/star/sdb/XInteractionDocumentSave.idl +++ b/offapi/com/sun/star/sdb/XInteractionDocumentSave.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module sdb { <p> This continuation is typically used in conjunction with a - <type scope="com::sun::star::sdb">DocumentSaveRequest</type>. + com::sun::star::sdb::DocumentSaveRequest. </p> @since OOo 2.0 */ diff --git a/offapi/com/sun/star/sdb/XInteractionSupplyParameters.idl b/offapi/com/sun/star/sdb/XInteractionSupplyParameters.idl index 5e5d88e10d04..1d28ea2d7b7c 100644 --- a/offapi/com/sun/star/sdb/XInteractionSupplyParameters.idl +++ b/offapi/com/sun/star/sdb/XInteractionSupplyParameters.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module sdb { <p> This continuation is typically used in conjunction with a - <type scope="com::sun::star::sdb">ParametersRequest</type>. + com::sun::star::sdb::ParametersRequest. </p> */ published interface XInteractionSupplyParameters: com::sun::star::task::XInteractionContinuation diff --git a/offapi/com/sun/star/sdb/XResultSetAccess.idl b/offapi/com/sun/star/sdb/XResultSetAccess.idl index 376e0b149936..825b904e95d9 100644 --- a/offapi/com/sun/star/sdb/XResultSetAccess.idl +++ b/offapi/com/sun/star/sdb/XResultSetAccess.idl @@ -34,14 +34,14 @@ /** is the interface to create a - <type scope="com::sun::star::sdbc">ResultSet</type> + com::sun::star::sdbc::ResultSet based on the object providing the interface. */ published interface XResultSetAccess: com::sun::star::uno::XInterface { /** returns a new - <type scope="com::sun::star::sdbc">ResultSet</type> + com::sun::star::sdbc::ResultSet based on the object. @returns the new created ResultSet object diff --git a/offapi/com/sun/star/sdb/XSQLErrorBroadcaster.idl b/offapi/com/sun/star/sdb/XSQLErrorBroadcaster.idl index ed2eef297c17..618bd17d3f49 100644 --- a/offapi/com/sun/star/sdb/XSQLErrorBroadcaster.idl +++ b/offapi/com/sun/star/sdb/XSQLErrorBroadcaster.idl @@ -28,7 +28,7 @@ /** interface for notifying potential listeners of - <type scope="com::sun::star::sdbc">SQLException</type> + com::sun::star::sdbc::SQLException s posted by any database object. */ published interface XSQLErrorBroadcaster: com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/sdb/XSQLErrorListener.idl b/offapi/com/sun/star/sdb/XSQLErrorListener.idl index 7e83f979c401..542c8f23af1b 100644 --- a/offapi/com/sun/star/sdb/XSQLErrorListener.idl +++ b/offapi/com/sun/star/sdb/XSQLErrorListener.idl @@ -33,7 +33,7 @@ published interface XSQLErrorListener: com::sun::star::lang::XEventListener { /** invoked when a database error occurs, just before a - <type scope="com::sun::star::sdbc">SQLException</type> + com::sun::star::sdbc::SQLException is thrown to the application. @param aEvent the event which occurred diff --git a/offapi/com/sun/star/sdb/XSQLQueryComposer.idl b/offapi/com/sun/star/sdb/XSQLQueryComposer.idl index 7571bef6f0d6..749c94a45e07 100644 --- a/offapi/com/sun/star/sdb/XSQLQueryComposer.idl +++ b/offapi/com/sun/star/sdb/XSQLQueryComposer.idl @@ -98,7 +98,7 @@ published interface XSQLQueryComposer: com::sun::star::uno::XInterface string getOrder(); /** appends a new filter condition by a - <type scope="com::sun::star::sdb">DataColumn</type> + com::sun::star::sdb::DataColumn providing the name and the value for the filter. @param column the column which is used to create a filter diff --git a/offapi/com/sun/star/sdb/XSQLQueryComposerFactory.idl b/offapi/com/sun/star/sdb/XSQLQueryComposerFactory.idl index fc25b28f9c94..e11d554547e0 100644 --- a/offapi/com/sun/star/sdb/XSQLQueryComposerFactory.idl +++ b/offapi/com/sun/star/sdb/XSQLQueryComposerFactory.idl @@ -25,7 +25,7 @@ /** is a factory for instances of service - <type scope="com::sun::star::sdb">SQLQueryComposer</type> + com::sun::star::sdb::SQLQueryComposer . */ published interface XSQLQueryComposerFactory: com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl b/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl index 8bd9efc5cb0e..b54eb937183e 100644 --- a/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl +++ b/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl @@ -75,7 +75,7 @@ interface XSingleSelectQueryAnalyzer : com::sun::star::uno::XInterface The filter criteria is split into levels. Each level represents the OR criteria. 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. The operator used, is defined by <type scope="com::sun::star::sdb">SQLFilterOperator</type>. + is of type string. The operator used, is defined by com::sun::star::sdb::SQLFilterOperator. </p> @returns the structured filter @@ -100,7 +100,7 @@ interface XSingleSelectQueryAnalyzer : com::sun::star::uno::XInterface The columns returned form the GROUP BY clause. </p> @returns - a collection of <type scope="com::sun::star::sdb">GroupColumn</type> which form the GROUP BY. + a collection of com::sun::star::sdb::GroupColumn which form the GROUP BY. */ com::sun::star::container::XIndexAccess getGroupColumns(); @@ -121,7 +121,7 @@ interface XSingleSelectQueryAnalyzer : com::sun::star::uno::XInterface The HAVING filter criteria is split into levels. Each level represents the OR criteria. 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. The operator used, is defined by <type scope="com::sun::star::sdb">SQLFilterOperator</type>. + is of type string. The operator used, is defined by com::sun::star::sdb::SQLFilterOperator. </p> @returns the structured HAVING filter @@ -146,7 +146,7 @@ interface XSingleSelectQueryAnalyzer : com::sun::star::uno::XInterface select command, but it does not contain the ORDER BY keyword . </p> @returns - a collection of <type scope="com::sun::star::sdb">OrderColumn</type> which form the ORDER BY. + a collection of com::sun::star::sdb::OrderColumn which form the ORDER BY. */ com::sun::star::container::XIndexAccess getOrderColumns(); diff --git a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl index e47ddf6f4b41..e5de0382d433 100644 --- a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl +++ b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl @@ -60,7 +60,7 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer The filter criteria is split into levels. Each level represents the OR criteria. 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. The operator used, is defined by <type scope="com::sun::star::sdb">SQLFilterOperator</type>. + is of type string. The operator used, is defined by com::sun::star::sdb::SQLFilterOperator. @throws com::sun::star::sdbc::SQLException if a database access error occurs. @@ -69,9 +69,9 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer raises (com::sun::star::sdbc::SQLException,com::sun::star::lang::IllegalArgumentException); /** appends a new filter condition by a - <type scope="com::sun::star::sdb">DataColumn</type> + com::sun::star::sdb::DataColumn providing the name and the value for the filter. - The value property must be supported by the <type scope="com::sun::star::sdb">DataColumn</type>. + The value property must be supported by the com::sun::star::sdb::DataColumn. @param column the column which is used to create a filter @param andCriteria @@ -79,7 +79,7 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer the new filter condition will be appended as OR criteria. E.g. (xx AND bb AND cc) OR newCriteria @param filterOperator - The operator used, is defined by <type scope="com::sun::star::sdb">SQLFilterOperator</type>. + The operator used, is defined by com::sun::star::sdb::SQLFilterOperator. @throws com::sun::star::sdbc::SQLException if a database access error occurs. */ @@ -102,7 +102,7 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer /** appends an additional part to the group criteria of the select - statement. The column must be a <type scope="com::sun::star::sdbcx">Column</type>. + statement. The column must be a com::sun::star::sdbcx::Column. @param column the column which is used to create a group part @throws com::sun::star::sdbc::SQLException @@ -130,7 +130,7 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer The HAVING filter criteria is split into levels. Each level represents the OR criteria. 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. The operator used, is defined by <type scope="com::sun::star::sdb">SQLFilterOperator</type>. + is of type string. The operator used, is defined by com::sun::star::sdb::SQLFilterOperator. @throws com::sun::star::sdbc::SQLException if a database access error occurs. @@ -139,7 +139,7 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer raises (com::sun::star::sdbc::SQLException); /** appends a new HAVING filter condition by a - <type scope="com::sun::star::sdb">DataColumn</type> + com::sun::star::sdb::DataColumn providing the name and the value for the filter. @param column the column which is used to create a filter @@ -148,7 +148,7 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer the new filter condition will be appended as OR criteria. E.g. (xx AND bb AND cc) OR newCriteria @param filterOperator - The operator used, is defined by <type scope="com::sun::star::sdb">SQLFilterOperator</type>. + The operator used, is defined by com::sun::star::sdb::SQLFilterOperator. @throws com::sun::star::sdbc::SQLException if a database access error occurs. */ @@ -170,7 +170,7 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer /** appends an additional part to the sort order criteria of the select - statement. The column must be a <type scope="com::sun::star::sdbcx">Column</type>. + statement. The column must be a com::sun::star::sdbcx::Column. @param column the column which is used to create a order part @param ascending diff --git a/offapi/com/sun/star/sdb/XSubDocument.idl b/offapi/com/sun/star/sdb/XSubDocument.idl index 8cfc92171b06..fe3e84ec97ef 100644 --- a/offapi/com/sun/star/sdb/XSubDocument.idl +++ b/offapi/com/sun/star/sdb/XSubDocument.idl @@ -39,8 +39,8 @@ interface XSubDocument on the desktop.</p> @return - the sub document, usually an <type scope="com::sun::star::frame">XModel</type>, - or an <type scope="com::sun::star::frame">XController</type> if the sub document + the sub document, usually an com::sun::star::frame::XModel, + or an com::sun::star::frame::XController if the sub document does not have an own model. @throws ::com::sun::star::lang::WrappedTargetException @@ -53,8 +53,8 @@ interface XSubDocument /** opens the sub document in design mode @return - the sub document, usually an <type scope="com::sun::star::frame">XModel</type>, - or an <type scope="com::sun::star::frame">XController</type> if the sub document + the sub document, usually an com::sun::star::frame::XModel, + or an com::sun::star::frame::XController if the sub document does not have an own model. @throws ::com::sun::star::lang::WrappedTargetException diff --git a/offapi/com/sun/star/sdb/application/CopyTableRowEvent.idl b/offapi/com/sun/star/sdb/application/CopyTableRowEvent.idl index a6529557d3a3..bdf1df424306 100644 --- a/offapi/com/sun/star/sdb/application/CopyTableRowEvent.idl +++ b/offapi/com/sun/star/sdb/application/CopyTableRowEvent.idl @@ -43,7 +43,7 @@ struct CopyTableRowEvent : ::com::sun::star::lang::EventObject /** denotes the error which happened while copying the data. - <p>Usually, this contains an instance of <type scope="com::sun::star::sdbc">SQLException</type>.</p> + <p>Usually, this contains an instance of com::sun::star::sdbc::SQLException.</p> */ any Error; }; diff --git a/offapi/com/sun/star/sdb/application/CopyTableWizard.idl b/offapi/com/sun/star/sdb/application/CopyTableWizard.idl index 52a6f4d4e43f..03c07a7bec9f 100644 --- a/offapi/com/sun/star/sdb/application/CopyTableWizard.idl +++ b/offapi/com/sun/star/sdb/application/CopyTableWizard.idl @@ -92,7 +92,7 @@ service CopyTableWizard : XCopyTableWizard then this connection will be disposed upon disposal of the wizard.</p> @param Source - the <type scope="com::sun::star::sdb">DataAccessDescriptor</type> describing the + the com::sun::star::sdb::DataAccessDescriptor describing the data to copy. <p>The following members of the <code>DataAccessDescriptor</code> are supported, and evaluated @@ -116,8 +116,8 @@ service CopyTableWizard : XCopyTableWizard <member scope="com::sun::star::sdb">CommandType::QUERY</member> are supported.</li> <li>If you specify a <code>ConnectionResource</code>, or an - <code>ActiveConnection</code> which implements an <type scope="com::sun::star::sdbc">Connection</type> only - (as opposed to a <type scope="com::sun::star::sdb">Connection</type>), then the resulting connection is + <code>ActiveConnection</code> which implements an com::sun::star::sdbc::Connection only + (as opposed to a com::sun::star::sdb::Connection), then the resulting connection is not able to provide queries, thus a command type <code>QUERY</code> will be rejected.</li> <li><code>Filter</code>, <code>Order</code>, <code>HavingClause</code> and <code>GroupBy</code> @@ -126,7 +126,7 @@ service CopyTableWizard : XCopyTableWizard Violating any of the above restrictions will result in an error at creation time.</p> @param Destination - the <type scope="com::sun::star::sdb">DataAccessDescriptor</type> describing the + the com::sun::star::sdb::DataAccessDescriptor describing the target for the copy operation. <p>Only <code>DataSourceName</code>, <code>DatabaseLocation</code>, <code>ActiveConnection</code> @@ -134,7 +134,7 @@ service CopyTableWizard : XCopyTableWizard in the order mentioned here, so if multiple of the are present, only the first one is evaluated.</p> <p>Also, at the moment the connection which is implied by either of the settings above - must support the <type scope="com::sun::star::sdb">Connection</type> service. In particular, + must support the com::sun::star::sdb::Connection service. In particular, it is not sufficient to pass an SDBC-level connection.</p> <p>Note that creating a view (see <member>CopyTableOperation::CreateAsView</member>) is @@ -156,7 +156,7 @@ service CopyTableWizard : XCopyTableWizard @throws ::com::sun::star::lang::WrappedTargetException if an error other than the ones mentioned above occurs while extracting the necessary information from any of the data access descriptors. For instance, this might - be an <type scope="com::sun::star::sdbc">SQLException</type> thrown upon connecting + be an com::sun::star::sdbc::SQLException thrown upon connecting to a data source described by the descriptor's <code>DataSourceName</code> member. @see ::com::sun::star::sdb::DataAccessDescriptor @@ -182,8 +182,8 @@ service CopyTableWizard : XCopyTableWizard specifies an interaction handler to use when user input is required. <p>When specifying this parameter, you should use an implementation - supporting the <type scope="com::sun::star::sdb">InteractionHandler</type>, since - the general-purpose <type scope="com::sun::star::task">InteractionHandler</type> cannot + supporting the com::sun::star::sdb::InteractionHandler, since + the general-purpose com::sun::star::task::InteractionHandler cannot handle all requests described <a href="#interaction">above</a>.</p> @see ::com::sun::star::sdb::InteractionHandler diff --git a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl index be5507584cba..7c1495f8c6c3 100644 --- a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl +++ b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl @@ -53,7 +53,7 @@ interface XDatabaseDocumentUI /** provides access to the application's main window <p>Note that reading this attribute is equivalent to querying the component - for the <type scope="com::sun::star::frame">XController</type> interface, + for the com::sun::star::frame::XController interface, asking the controller for its frame, and asking this frame for its container window.</p> @@ -99,9 +99,9 @@ interface XDatabaseDocumentUI forms, reports, tables, queries. Those components are tracked by the application, and provided in this attribute.</p> - <p>The components here might either be documents (<type scope="com::sun::star::frame">XModel</type>), - controllers (<type scope="com::sun::star::frame">XController</type>), or frames - (<type scope="com::sun::star::frame">XFrame</type>). + <p>The components here might either be documents (com::sun::star::frame::XModel), + controllers (com::sun::star::frame::XController), or frames + (com::sun::star::frame::XFrame). @since OOo 3.0 */ @@ -161,8 +161,8 @@ interface XDatabaseDocumentUI it allows opening a table, query, form, or report for either editing or viewing.</p> <p>This method is a convenience wrapper for API which is also available otherwise. For instance, - for loading forms and reports, you could use the <type scope="com::sun::star::frame">XComponentLoader</type> - interface of the <type scope="::com::sun::star::sdb">Forms</type> resp. <type scope="::com::sun::star::sdb">Reports</type> + for loading forms and reports, you could use the com::sun::star::frame::XComponentLoader + interface of the ::com::sun::star::sdb::Forms resp. ::com::sun::star::sdb::Reports collections.</p> <p>Note there must exist a connection to the database before you can call this method.</p> @@ -195,17 +195,17 @@ interface XDatabaseDocumentUI <tr style="vertical-align: top;"> <td><em>Tables</em></td> <td>A table designer is opened, and allows to edit the structure of the table. - See also <type scope="::com::sun::star::sdb">TableDesign</type></td> + See also ::com::sun::star::sdb::TableDesign</td> <td>A table data view is opened, and allows to view and edit the data contained in the table. - See also <type scope="::com::sun::star::sdb">DataSourceBrowser</type></td> + See also ::com::sun::star::sdb::DataSourceBrowser</td> </tr> <tr style="vertical-align: top;"> <td><em>Queries</em></td> <td>A query designer is opened, and allows to edit the statement constituting the query. - See also <type scope="::com::sun::star::sdb">QueryDesign</type></td> + See also ::com::sun::star::sdb::QueryDesign</td> <td>A table data view is opened, and allows to view and edit the data contained in the query. - See also <type scope="::com::sun::star::sdb">DataSourceBrowser</type></td> + See also ::com::sun::star::sdb::DataSourceBrowser</td> </tr> <tr style="vertical-align: top;"> @@ -225,8 +225,8 @@ interface XDatabaseDocumentUI </p> @return - the component which has been loaded. This is either an <type scope="com::sun::star::frame">XModel</type>, - or an <type scope="com::sun::star::frame">XController</type> if the component does is model-less. + the component which has been loaded. This is either an com::sun::star::frame::XModel, + or an com::sun::star::frame::XController if the component does is model-less. @throws ::com::sun::star::lang::IllegalArgumentException if <arg>ObjectType</arg> denotes an invalid object type @@ -271,7 +271,7 @@ interface XDatabaseDocumentUI @param DocumentDefinition Upon successful return, and if and only if <arg>ObjectType</arg> equals <member>DatabaseObject::FORM</member> - or <member>DatabaseObject::REPORT</member>, this will contain the <type scope="com::sun::star::sdb">DocumentDefinition</type> + or <member>DatabaseObject::REPORT</member>, this will contain the com::sun::star::sdb::DocumentDefinition object which controls the sub component. */ ::com::sun::star::lang::XComponent createComponent( @@ -295,7 +295,7 @@ interface XDatabaseDocumentUI @param DocumentDefinition Upon successful return, and if and only if <arg>ObjectType</arg> equals <member>DatabaseObject::FORM</member> - or <member>DatabaseObject::REPORT</member>, this will contain the <type scope="com::sun::star::sdb">DocumentDefinition</type> + or <member>DatabaseObject::REPORT</member>, this will contain the com::sun::star::sdb::DocumentDefinition object which controls the sub component.<br/> You can use this object to control various aspects of the sub component. For instance, you could decide to create the component hidden, by passing a <code>Hidden</code> flag (set to <TRUE/>) in <arg>Arguments</arg>, diff --git a/offapi/com/sun/star/sdb/application/XTableUIProvider.idl b/offapi/com/sun/star/sdb/application/XTableUIProvider.idl index 2aef3190cfd9..2d6ef3208687 100644 --- a/offapi/com/sun/star/sdb/application/XTableUIProvider.idl +++ b/offapi/com/sun/star/sdb/application/XTableUIProvider.idl @@ -51,7 +51,7 @@ interface XTableUIProvider @param ColorMode denotes the color mode of the graphic to retrieve, being one of the - <type scope="com::sun::star::graphic">GraphicColorMode</type> constants. + com::sun::star::graphic::GraphicColorMode constants. @return the icon which should be used to represent the table in the database application window, or <NULL/> if the default icon @@ -79,11 +79,11 @@ interface XTableUIProvider Two component types are supported so far <ul><li>modal dialogs<br/> If the returned component supports the - <type scope="com::sun::star::ui::dialogs">XExecutableDialog</type> + com::sun::star::ui::dialogs::XExecutableDialog interface, the dialog will be executed modally.</li> <li>modeless frames<br/> If the returned component supports the - <type scope="com::sun::star::frame">XController</type> + com::sun::star::frame::XController interface, it is assumed that it represents a controller, loaded into a new frame, which is a modeless and, in its lifetime, depends on the application main window.</li> diff --git a/offapi/com/sun/star/sdb/tools/XConnectionTools.idl b/offapi/com/sun/star/sdb/tools/XConnectionTools.idl index 8561c794a8ef..31ab32de2a05 100644 --- a/offapi/com/sun/star/sdb/tools/XConnectionTools.idl +++ b/offapi/com/sun/star/sdb/tools/XConnectionTools.idl @@ -40,13 +40,13 @@ interface XObjectNames; interface XDataSourceMetaData; /** encapsulates various useful functionality around a - <type scope="com::sun::star::sdb">Connection</type> + com::sun::star::sdb::Connection <p>Most of the functionality provided here is meaningful only relative to a given database connection. For instance, for quoting table names, you need the meta data instance of the connection. Thus, the entry point for obtaining a XConnectionTools instance is the - <type scope="com::sun::star::sdb">Connection</type> service.</p> + com::sun::star::sdb::Connection service.</p> <p>Note that nearly all functionality provided by this interface is also available by other means, it's only provided here for convenience purposes.</p> @@ -77,9 +77,9 @@ interface XConnectionTools /** get fields for a result set given by a "command descriptor" <p>A command descriptor here means: - <ul><li>a SDB-level connection (<type scope="com.sun.star.sdb">Connection</type></li> + <ul><li>a SDB-level connection (com.sun.star.sdb::Connection</li> <li>a string specifying the name of an object relative to the connection</li> - <li>a <type scope="com.sun.star.sdb">CommandType</type> value specifying the type + <li>a com.sun.star.sdb::CommandType value specifying the type of the object</type></li> </ul> </p> diff --git a/offapi/com/sun/star/sdb/tools/XObjectNames.idl b/offapi/com/sun/star/sdb/tools/XObjectNames.idl index 304c2e126163..34777ad324bc 100644 --- a/offapi/com/sun/star/sdb/tools/XObjectNames.idl +++ b/offapi/com/sun/star/sdb/tools/XObjectNames.idl @@ -40,14 +40,14 @@ module com { module sun { module star { module sdb { module tools { unique. Using this interface, you can easily ensure this uniqueness.</p> <p>All of the functionality present in this interface depends on a connection, - thus it entry point for obtaining it is a <type scope="com::sun::star::sdb">Connection</type> + thus it entry point for obtaining it is a com::sun::star::sdb::Connection service.</p> <p>The component itself does not have life-time control mechanisms, i.e. you cannot explicitly dispose it (<member scope="com::sun::star::lang">XComponent::dispose</member>), and you cannot be notified when it dies.<br/> However, if your try to access any of its methods or attributes, after the - connection which was used to create it was closed, a <type scope="com::sun::star::lang">DisposedException</type> + connection which was used to create it was closed, a com::sun::star::lang::DisposedException will be thrown.</p> @see XConnectionTools @@ -71,7 +71,7 @@ interface XObjectNames you are actually creating the table respectively query.</p> @param CommandType - specifies the <type scope="com::sun::star::sdb">CommandType</type> of the object for which + specifies the com::sun::star::sdb::CommandType of the object for which a unique name is to be generated. Must be either <member scope="com::sun::star::sdb">CommandType::TABLE</member> or <member scope="com::sun::star::sdb">CommandType::QUERY</member>. @@ -106,7 +106,7 @@ interface XObjectNames application driven by user interactions.</p> @param CommandType - specifies the <type scope="com::sun::star::sdb">CommandType</type> of the object whose + specifies the com::sun::star::sdb::CommandType of the object whose name should be checked. Must be either <member scope="com::sun::star::sdb">CommandType::TABLE</member> or <member scope="com::sun::star::sdb">CommandType::QUERY</member>. diff --git a/offapi/com/sun/star/sdb/tools/XTableName.idl b/offapi/com/sun/star/sdb/tools/XTableName.idl index 642a7ae13548..5c96f75461e1 100644 --- a/offapi/com/sun/star/sdb/tools/XTableName.idl +++ b/offapi/com/sun/star/sdb/tools/XTableName.idl @@ -44,7 +44,7 @@ module com { module sun { module star { module sdb { module tools { cannot explicitly dispose it (<member scope="com::sun::star::lang">XComponent::dispose</member>), and you cannot be notified when it dies.<br/> However, if your try to access any of its methods or attributes, after the - connection which was used to create it was closed, a <type scope="com::sun::star::lang">DisposedException</type> + connection which was used to create it was closed, a com::sun::star::lang::DisposedException will be thrown.</p> @see XConnectionTools @@ -105,11 +105,11 @@ interface XTableName */ [attribute, readonly] string NameForSelect; - /** is the <type scope="com::sun::star::sdb">Table</type> object specified + /** is the com::sun::star::sdb::Table object specified by the current name. <p>Retrieving this attribute is equivalent to obtaining the tables - container from the connection (via <type scope="com::sun::star::sdbcx">XTablesSupplier</type>), + container from the connection (via com::sun::star::sdbcx::XTablesSupplier), and calling its <member scope="com::sun::star::container">XNameAccess::getByName</member> method with the ComposedName.</p> |