diff options
author | Michael Hönnig <mi@openoffice.org> | 2001-10-25 14:35:32 +0000 |
---|---|---|
committer | Michael Hönnig <mi@openoffice.org> | 2001-10-25 14:35:32 +0000 |
commit | 05a4762ae7529ab0d9089eebcc92c4fac2e5baf1 (patch) | |
tree | e3b66cb1bbd63cefc23f7e0a7ed10915ef8bc088 /offapi/com/sun | |
parent | 4464790b2e4439fd0b6d4b2963e032bb89b29085 (diff) |
proofreading and corrections from Richard Holt
Diffstat (limited to 'offapi/com/sun')
29 files changed, 213 insertions, 138 deletions
diff --git a/offapi/com/sun/star/sdbcx/CompareBookmark.idl b/offapi/com/sun/star/sdbcx/CompareBookmark.idl index bf64354d63d3..4af2a30b8e46 100644 --- a/offapi/com/sun/star/sdbcx/CompareBookmark.idl +++ b/offapi/com/sun/star/sdbcx/CompareBookmark.idl @@ -2,9 +2,9 @@ * * $RCSfile: CompareBookmark.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:39 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,7 +71,7 @@ constants CompareBookmark { // DocMerge from idl: value com::sun::star::sdbcx::CompareBookmark::LESS - /** the first bookmark is before the second located. + /** the first bookmark is before the second. */ const long LESS = -1; @@ -83,19 +83,19 @@ constants CompareBookmark // DocMerge from idl: value com::sun::star::sdbcx::CompareBookmark::GREATER - /** the first bookmark is behind the second one. + /** the first bookmark is after the second one. */ const long GREATER = 1; // DocMerge from idl: value com::sun::star::sdbcx::CompareBookmark::NOT_EQUAL - /** the first bookmark is behind the second one. + /** the first bookmark is not the same as the second one. */ const long NOT_EQUAL = 2; // DocMerge from idl: value com::sun::star::sdbcx::CompareBookmark::NOT_COMPARABLE - /** The two bookmarks can not be compared. + /** the two bookmarks are not comparable. */ const long NOT_COMPARABLE = 3; }; @@ -106,6 +106,9 @@ constants CompareBookmark /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:43:39 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:43 hjs initial import diff --git a/offapi/com/sun/star/sdbcx/Container.idl b/offapi/com/sun/star/sdbcx/Container.idl index a39421da4f27..5199f50a5332 100644 --- a/offapi/com/sun/star/sdbcx/Container.idl +++ b/offapi/com/sun/star/sdbcx/Container.idl @@ -2,9 +2,9 @@ * * $RCSfile: Container.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-23 10:08:32 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,10 +80,9 @@ interface XDrop; // DocMerge from xml: service com::sun::star::container::com::sun::star::util::com::sun::star::sdbcx::Container /** describes every container which is used for data definition. Each - container must support the access to its elements by the element's name or + container must support access to its elements by the element's name or by the element's position. - <p>Simple enumeration must be supported as well. </p> <p>To reflect the changes with the underlying database, a refresh mechanism @@ -134,6 +133,9 @@ service Container /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/01/23 10:08:32 mi + optional interfaces now marked as [optional] instead of just a prosa description of this fact + Revision 1.3 2000/11/08 12:43:39 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/DatabaseDefinition.idl b/offapi/com/sun/star/sdbcx/DatabaseDefinition.idl index 698dd4d674ce..8da63c402389 100644 --- a/offapi/com/sun/star/sdbcx/DatabaseDefinition.idl +++ b/offapi/com/sun/star/sdbcx/DatabaseDefinition.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseDefinition.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-23 10:08:33 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,14 +71,14 @@ interface XGroupsSupplier; // DocMerge from xml: service com::sun::star::sdbcx::DatabaseDefinition /** could be used as an extension for performing data definition tasks on - databases and to control the access rights on database objects. + databases, and to control the access rights on database objects. <p>It may be implemented by a database driver provider, to encapsulate the - complexity of data definition and to give a common way for data definition as + complexity of data definition, and to give a common way for data definition as the DDL of most DBMS's differs. </p> - <p>At least the access to the tables of a database should be implemented. + <p>At least, the access to the tables of a database should be implemented. The implementation of other known database objects like views is optional. </p> <p>To control the access rights of users, there is the possibility to @@ -111,6 +111,9 @@ service DatabaseDefinition /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/01/23 10:08:33 mi + optional interfaces now marked as [optional] instead of just a prosa description of this fact + Revision 1.3 2000/11/08 12:43:39 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/Descriptor.idl b/offapi/com/sun/star/sdbcx/Descriptor.idl index 4976c1cc2916..7078b3f75316 100644 --- a/offapi/com/sun/star/sdbcx/Descriptor.idl +++ b/offapi/com/sun/star/sdbcx/Descriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: Descriptor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:39 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,9 +72,9 @@ /** is used to create a new object within a database. <p> - A descriptor is commonly create by the container of specific objects like tables or views. + A descriptor is commonly created by the container of a specific object, such as, tables or views. After the the creation of the descriptor the properties have to be filled. - Afterwards you append the descriptor to the container and the container creates a new object based + Afterwards, you append the descriptor to the container and the container creates a new object based on the informations of the descriptor. </p> <p>A descriptor containes at least the informations of the name of an object. @@ -99,6 +99,9 @@ service Descriptor /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:43:39 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:43 hjs initial import diff --git a/offapi/com/sun/star/sdbcx/Driver.idl b/offapi/com/sun/star/sdbcx/Driver.idl index 4fdf5ba605b2..18511bbca691 100644 --- a/offapi/com/sun/star/sdbcx/Driver.idl +++ b/offapi/com/sun/star/sdbcx/Driver.idl @@ -2,9 +2,9 @@ * * $RCSfile: Driver.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-23 10:08:33 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,18 +75,15 @@ interface XDropCatalog; // DocMerge from xml: service com::sun::star::sdbcx::Driver /** extends the service <type scope="com::sun::star::sdbc">Driver</type> by beans for data definition. - - - - <p>This service is optional for each driver. Its purpose is to define +<p> + This service is optional for each driver. Its purpose is to define a common way for database definition, as the DDL differs between most DBMS. - - </p> - <p>Definition and deletion of database catalogs can't be defined in a common - manner for DBMS. But it should be possible to hide much of the complexitivity +</p><p> + Definition and deletion of database catalogs can't be defined in a common + manner for DBMS, but it should be possible to hide much of the complexity of creation and deletion of catalogs. Each driver could provide methods to cover these tasks. - </p> +</p> */ service Driver { @@ -114,6 +111,9 @@ service Driver /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/01/23 10:08:33 mi + optional interfaces now marked as [optional] instead of just a prosa description of this fact + Revision 1.3 2000/11/08 12:43:39 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/IndexColumnDescriptor.idl b/offapi/com/sun/star/sdbcx/IndexColumnDescriptor.idl index c0f63ddd4a8f..a5252276321c 100644 --- a/offapi/com/sun/star/sdbcx/IndexColumnDescriptor.idl +++ b/offapi/com/sun/star/sdbcx/IndexColumnDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: IndexColumnDescriptor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:39 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,7 +69,7 @@ // DocMerge from xml: service com::sun::star::sdbcx::IndexColumnDescriptor -/** adds an property to determine the sort order of the column values within the +/** adds a property to determine the sort order of the column values within the index. Some database drivers may ignore this property. */ service IndexColumnDescriptor @@ -90,6 +90,9 @@ service IndexColumnDescriptor /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:43:39 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:43 hjs initial import diff --git a/offapi/com/sun/star/sdbcx/IndexDescriptor.idl b/offapi/com/sun/star/sdbcx/IndexDescriptor.idl index b165feabeb29..b9ab4290cf18 100644 --- a/offapi/com/sun/star/sdbcx/IndexDescriptor.idl +++ b/offapi/com/sun/star/sdbcx/IndexDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: IndexDescriptor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:39 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,7 +71,8 @@ interface XColumnsSupplier; // DocMerge from xml: service com::sun::star::sdbcx::IndexDescriptor -/** is used to define a new index for a database table.@see com::sun::star::sdbcx::Index +/** is used to define a new index for a database table. +@see com::sun::star::sdbcx::Index */ service IndexDescriptor { @@ -109,6 +110,9 @@ service IndexDescriptor /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:43:39 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:43 hjs initial import diff --git a/offapi/com/sun/star/sdbcx/Key.idl b/offapi/com/sun/star/sdbcx/Key.idl index 690ebaabcdbb..af71eaf052c7 100644 --- a/offapi/com/sun/star/sdbcx/Key.idl +++ b/offapi/com/sun/star/sdbcx/Key.idl @@ -2,9 +2,9 @@ * * $RCSfile: Key.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-23 10:08:33 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,7 +78,7 @@ service Key { // DocMerge from xml: service com::sun::star::sdbcx::Key: interface com::sun::star::sdbcx::XDataDescriptorFactory - /** optional, could be used to copy an key. + /** optional, could be used to copy a key. */ [optional] interface XDataDescriptorFactory; @@ -129,6 +129,9 @@ service Key /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/01/23 10:08:33 mi + optional interfaces now marked as [optional] instead of just a prosa description of this fact + Revision 1.3 2000/11/08 12:43:39 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/KeyColumn.idl b/offapi/com/sun/star/sdbcx/KeyColumn.idl index 34c05da5ee7a..5a1d515da23d 100644 --- a/offapi/com/sun/star/sdbcx/KeyColumn.idl +++ b/offapi/com/sun/star/sdbcx/KeyColumn.idl @@ -2,9 +2,9 @@ * * $RCSfile: KeyColumn.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:39 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,7 +68,7 @@ module com { module sun { module star { module sdbcx { /** - adds an property to specify the referenced column. This is used to specify + adds a property to specify the referenced column. This is used to specify foreign keys. */ diff --git a/offapi/com/sun/star/sdbcx/KeyColumnDescriptor.idl b/offapi/com/sun/star/sdbcx/KeyColumnDescriptor.idl index 6dda369715dd..9cd763100d0e 100644 --- a/offapi/com/sun/star/sdbcx/KeyColumnDescriptor.idl +++ b/offapi/com/sun/star/sdbcx/KeyColumnDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: KeyColumnDescriptor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:39 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,7 +69,7 @@ // DocMerge from xml: service com::sun::star::sdbcx::KeyColumnDescriptor -/** adds an property to specify the referenced column. This is used to specify +/** adds a property to specify the referenced column. This is used to specify foreign keys.@see com::sun::star::sdbcx::KeyColumn */ service KeyColumnDescriptor @@ -90,6 +90,9 @@ service KeyColumnDescriptor /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:43:39 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:43 hjs initial import diff --git a/offapi/com/sun/star/sdbcx/KeyDescriptor.idl b/offapi/com/sun/star/sdbcx/KeyDescriptor.idl index 78d061be01ba..8e4a2b97ef89 100644 --- a/offapi/com/sun/star/sdbcx/KeyDescriptor.idl +++ b/offapi/com/sun/star/sdbcx/KeyDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: KeyDescriptor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:39 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,8 +86,7 @@ service Key */ [property] long Type; - /** is the name of the referenced table, only used for foreign - keys. */ + /** is the name of the referenced table, only used for foreign keys. */ [property] string ReferencedTable; /** is the rule which is applied for updates; only used for foreign keys. diff --git a/offapi/com/sun/star/sdbcx/PreparedStatement.idl b/offapi/com/sun/star/sdbcx/PreparedStatement.idl index 77c0f9562071..5d7e26a3773d 100644 --- a/offapi/com/sun/star/sdbcx/PreparedStatement.idl +++ b/offapi/com/sun/star/sdbcx/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:39 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,8 +68,9 @@ module com { module sun { module star { module sdbcx { /** - extends the definition of the service <type scope="com::sun::star::sdbc"> - PreparedStatement</type> with a flag for the usage of bookmarks. + extends the definition of the service +<type scope="com::sun::star::sdbc">PreparedStatement</type> + with a flag for the usage of bookmarks. @see ResultSet @see XRowLocate */ @@ -78,7 +79,7 @@ service Statement service com::sun::star::sdbc::PreparedStatement; /** returns if a resultset should allow the navigation with bookmarks - or not. The default is </FALSE>. + or not. The default is <FALSE/>. */ [property] boolean UseBookmarks; }; diff --git a/offapi/com/sun/star/sdbcx/Privilege.idl b/offapi/com/sun/star/sdbcx/Privilege.idl index 2efd42bb9464..9122b01a1d7b 100644 --- a/offapi/com/sun/star/sdbcx/Privilege.idl +++ b/offapi/com/sun/star/sdbcx/Privilege.idl @@ -2,9 +2,9 @@ * * $RCSfile: Privilege.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:39 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -121,7 +121,7 @@ constants Privilege //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbcx::Privilege::DROP - /** indicates that a user is allowed to drop a definition object . + /** indicates that a user is allowed to drop a definition object. */ const long DROP = 0x00000100; }; @@ -132,6 +132,9 @@ constants Privilege /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:43:39 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:44 hjs initial import diff --git a/offapi/com/sun/star/sdbcx/ResultSet.idl b/offapi/com/sun/star/sdbcx/ResultSet.idl index e0b6b4e35c17..c17ecde1d577 100644 --- a/offapi/com/sun/star/sdbcx/ResultSet.idl +++ b/offapi/com/sun/star/sdbcx/ResultSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: ResultSet.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-23 10:08:33 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,7 +73,7 @@ interface XDeleteRows; // DocMerge from xml: service com::sun::star::sdbcx::ResultSet /** extends the SDBC ResultSet by the possibility of bookmark positioning, cancelling - the positioning and updating of rows. + the positioning, and updating of rows. */ service ResultSet { @@ -83,22 +83,20 @@ service ResultSet // DocMerge from xml: service com::sun::star::sdbcx::ResultSet: interface com::sun::star::util::XCancellable /** could be used for cancelling the execution of SQL statements if both - if both the DBMS and the driver support aborting of navigation - commands. - The implementation is optional. + the DBMS and the driver support aborting of navigation commands. + The implementation is optional. */ [optional] interface com::sun::star::util::XCancellable; // DocMerge from xml: service com::sun::star::sdbcx::ResultSet: interface com::sun::star::sdbcx::XRowLocate - /** is the interface for navigating on the result set by unique - bookmarks. + /** is the interface for navigating on the result set by unique bookmarks. */ interface XRowLocate; // DocMerge from xml: service com::sun::star::sdbcx::ResultSet: interface com::sun::star::sdbcx::XDeleteRows - /** is the interface for delete more than one row identified by it's bookmark. + /** is the interface for deleting more than one row, identified by it's bookmark. The implementation is optional. */ [optional] interface XDeleteRows; @@ -126,6 +124,9 @@ service ResultSet /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/01/23 10:08:33 mi + optional interfaces now marked as [optional] instead of just a prosa description of this fact + Revision 1.3 2000/11/08 12:43:39 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/Statement.idl b/offapi/com/sun/star/sdbcx/Statement.idl index 88e3fe630e05..ac63d8e952a4 100644 --- a/offapi/com/sun/star/sdbcx/Statement.idl +++ b/offapi/com/sun/star/sdbcx/Statement.idl @@ -2,9 +2,9 @@ * * $RCSfile: Statement.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:40 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,8 +69,9 @@ // DocMerge from xml: service com::sun::star::sdbcx::Statement -/** extends the definition of the service <type scope="com::sun::star::sdbc">Statement</type> with a flag for the usage of bookmarks.@see ResultSet - @see XRowLocate +/** extends the definition of the service <type scope="com::sun::star::sdbc">Statement</type> with a flag for the usage of bookmarks. + @see ResultSet + @see XRowLocate */ service Statement { @@ -79,7 +80,7 @@ service Statement // DocMerge from xml: property com::sun::star::sdbcx::Statement::UseBookmarks - /** returns <TRUE/> if a resultset should allow the navigation with bookmarks + /** returns <TRUE/> if a resultset should allow navigation with bookmarks or not. The default is <FALSE/>. */ [property] boolean UseBookmarks; @@ -91,6 +92,9 @@ service Statement /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2000/12/14 12:53:40 mi + <true></true> -> <TRUE/> and same with FALSE + Revision 1.3 2000/11/08 12:43:39 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/Table.idl b/offapi/com/sun/star/sdbcx/Table.idl index fe186d6944a7..cad07c230997 100644 --- a/offapi/com/sun/star/sdbcx/Table.idl +++ b/offapi/com/sun/star/sdbcx/Table.idl @@ -2,9 +2,9 @@ * * $RCSfile: Table.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-23 10:08:34 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,18 +79,17 @@ interface XAlterTable; /** used to specify a table in a database. A table is described by its name and one or more columns. - <p>In addition, it may contain indexes to improve the performance in - the retrieval of the table's data and keys and to define semantic rules for the table. - </p> - <p> + the retrieval of the table's data and keys, and to define semantic rules for the table. + </p><p> <b>Note:</b> All properties and columns of a table could by modified before - it is appended to a database. In that case the service is in fact a + it is appended to a database. In that case, the service is in fact a descriptor. On existing tables, a user might alter columns, add or delete columns, indexes, and keys depending on the capabilities of the database and on - the user's privileges. - </p>@see com::sun::star::sdbc::XDatabaseMetaData - @see com::sun::star::sdbcx::Privilege + the user's privileges.</p> + + @see com::sun::star::sdbc::XDatabaseMetaData + @see com::sun::star::sdbcx::Privilege */ service Table { @@ -153,15 +152,15 @@ service Table // DocMerge from xml: property com::sun::star::sdbcx::Table::Description - /** supplies a comment on the table. Could be empty if not supported by + /** supplies a comment on the table. Could be empty, if not supported by the driver. */ [readonly, property] string Description; // DocMerge from xml: property com::sun::star::sdbcx::Table::Type - /** indicates the type of the table like (TABLE,VIEW,SYSTEM TABLE). - Could be empty if not supported by the driver. + /** indicates the type of the table like (TABLE, VIEW, SYSTEM TABLE). + Could be empty, if not supported by the driver. @optional */ @@ -174,6 +173,9 @@ service Table /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/01/23 10:08:34 mi + optional interfaces now marked as [optional] instead of just a prosa description of this fact + Revision 1.3 2000/11/08 12:43:39 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/TableDescriptor.idl b/offapi/com/sun/star/sdbcx/TableDescriptor.idl index 82d4af6dc413..9d3dedda71d0 100644 --- a/offapi/com/sun/star/sdbcx/TableDescriptor.idl +++ b/offapi/com/sun/star/sdbcx/TableDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableDescriptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-23 10:08:34 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,11 +72,11 @@ interface XKeysSupplier; // DocMerge from xml: service com::sun::star::sdbcx::TableDescriptor -/** is used to define an table of a database. A table is described by its +/** is used to define a table of a database. A table is described by its name and one or more columns and the keys for semantic rules. <p>In addition, it may contain indexes to improve the performance in - retrieve the tables data and keys, to define semantic rules for the table. + retrieving the tables data and keys, and to define semantic rules for the table. </p>@see com::sun::star::sdbcx::Table */ @@ -122,6 +122,9 @@ service TableDescriptor /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/01/23 10:08:34 mi + optional interfaces now marked as [optional] instead of just a prosa description of this fact + Revision 1.3 2000/11/08 12:43:39 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/User.idl b/offapi/com/sun/star/sdbcx/User.idl index d7a4105d5746..2454b266498f 100644 --- a/offapi/com/sun/star/sdbcx/User.idl +++ b/offapi/com/sun/star/sdbcx/User.idl @@ -2,9 +2,9 @@ * * $RCSfile: User.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-23 10:08:35 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,8 +72,8 @@ interface XUser; // DocMerge from xml: service com::sun::star::sdbcx::User -/** represents a user in the database who has certain access rights for the objects - of the database. +/** represents a user of the database, who has certain access rights + for the objects of the database. */ service User { @@ -81,8 +81,8 @@ service User interface XUser; // DocMerge from xml: service com::sun::star::sdbcx::User: interface com::sun::star::sdbcx::XGroupsSupplier - /** optional for implementation if the database does not know the concept - of user groups. provides the access to the groups a user belongs. + /** optional for implementation, if the database does not know the concept + of user groups. Provides for access to the groups to which a user belongs. */ [optional] interface XGroupsSupplier; @@ -102,6 +102,9 @@ service User /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/01/23 10:08:35 mi + optional interfaces now marked as [optional] instead of just a prosa description of this fact + Revision 1.3 2000/11/08 12:43:39 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XAlterTable.idl b/offapi/com/sun/star/sdbcx/XAlterTable.idl index 025ede23680f..8ba8c1227d50 100644 --- a/offapi/com/sun/star/sdbcx/XAlterTable.idl +++ b/offapi/com/sun/star/sdbcx/XAlterTable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAlterTable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -92,7 +92,8 @@ interface XAlterTable: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::beans::com::sun::star::sdbcx::XAlterTable::alterColumnByName /** is intended to alter an existing column identified by its name. This operation must be atomar. - */ + +<!-- JRH: My apologies, but what is 'atomar'? Please add, ", i.e., xxx xx xxxx". -->*/ void alterColumnByName([in]string colName, [in]com::sun::star::beans::XPropertySet descriptor) raises (com::sun::star::sdbc::SQLException, @@ -102,7 +103,8 @@ interface XAlterTable: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::beans::com::sun::star::sdbcx::XAlterTable::alterColumnByIndex /** is intended to alter an existing column identified by its position. This operation must be atomar. - */ + +<!-- JRH: atomar? --> */ void alterColumnByIndex([in]long index, [in]com::sun::star::beans::XPropertySet descriptor) raises (com::sun::star::sdbc::SQLException, @@ -115,6 +117,9 @@ interface XAlterTable: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XDeleteRows.idl b/offapi/com/sun/star/sdbcx/XDeleteRows.idl index 41d7008dde25..dfadf60d703f 100644 --- a/offapi/com/sun/star/sdbcx/XDeleteRows.idl +++ b/offapi/com/sun/star/sdbcx/XDeleteRows.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDeleteRows.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,7 +73,7 @@ // DocMerge from xml: interface com::sun::star::sdbcx::XDeleteRows -/** provides for the deletion of more than one rows at a time. +/** provides for the deletion of more than one row at a time. */ interface XDeleteRows: com::sun::star::uno::XInterface { @@ -81,14 +81,14 @@ interface XDeleteRows: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::sdbcx::XDeleteRows::deleteRows /** deletes one or more rows identified by their bookmarks. @param rows - list of bookmark identifying the rows. + list of bookmarks identifying the rows. @returns an array of update counts containing one element for each row. The array is ordered according to the order in which bookmarks were given. @throws SQLException - if a fatal error occurs like the connection get lost if bookmarks - used which do not belong to the according result set. + if a fatal error occurs, for intance, the connection gets lost if bookmarks + are used which do not belong to the according result set. */ sequence<long> deleteRows([in]sequence<any> rows) raises (com::sun::star::sdbc::SQLException); @@ -100,6 +100,9 @@ interface XDeleteRows: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XDropCatalog.idl b/offapi/com/sun/star/sdbcx/XDropCatalog.idl index 4eefd218ff14..f35e5633627a 100644 --- a/offapi/com/sun/star/sdbcx/XDropCatalog.idl +++ b/offapi/com/sun/star/sdbcx/XDropCatalog.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDropCatalog.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,7 +81,7 @@ // DocMerge from xml: interface com::sun::star::sdbcx::XDropCatalog -/** may be implemented to hide the complexity of droping a database catalog. Could +/** may be implemented to hide the complexity of dropping a database catalog. Could normally be used only in offline mode, no connection on the database. This should be checked by the driver. */ @@ -103,6 +103,9 @@ interface XDropCatalog: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XGroupsSupplier.idl b/offapi/com/sun/star/sdbcx/XGroupsSupplier.idl index a187a540f47d..4baab7bb93d4 100644 --- a/offapi/com/sun/star/sdbcx/XGroupsSupplier.idl +++ b/offapi/com/sun/star/sdbcx/XGroupsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XGroupsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,7 +73,7 @@ // DocMerge from xml: interface com::sun::star::sdbcx::XGroupsSupplier -/** provides the access to a container of groups, typically used for a database +/** provides for access to a container of groups, typically used for a database definition object. */ interface XGroupsSupplier: com::sun::star::uno::XInterface @@ -91,6 +91,9 @@ interface XGroupsSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XIndexesSupplier.idl b/offapi/com/sun/star/sdbcx/XIndexesSupplier.idl index f7168de7f005..5c947bbde528 100644 --- a/offapi/com/sun/star/sdbcx/XIndexesSupplier.idl +++ b/offapi/com/sun/star/sdbcx/XIndexesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIndexesSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,7 +73,7 @@ // DocMerge from xml: interface com::sun::star::sdbcx::XIndexesSupplier -/** provides the access to a container of indexes, typically used for a table +/** provides for access to a container of indexes, typically used for a table definition object. */ interface XIndexesSupplier: com::sun::star::uno::XInterface @@ -91,6 +91,9 @@ interface XIndexesSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XKeysSupplier.idl b/offapi/com/sun/star/sdbcx/XKeysSupplier.idl index 9c78adb3e302..3b48c4ba7f70 100644 --- a/offapi/com/sun/star/sdbcx/XKeysSupplier.idl +++ b/offapi/com/sun/star/sdbcx/XKeysSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XKeysSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,7 +73,7 @@ // DocMerge from xml: interface com::sun::star::sdbcx::XKeysSupplier -/** provides the access to a container of keys, typically used for a table +/** provides for access to a container of keys, typically used for a table definition object. */ interface XKeysSupplier: com::sun::star::uno::XInterface @@ -91,6 +91,9 @@ interface XKeysSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XRename.idl b/offapi/com/sun/star/sdbcx/XRename.idl index 75625dd8faeb..6a59247fd5ba 100644 --- a/offapi/com/sun/star/sdbcx/XRename.idl +++ b/offapi/com/sun/star/sdbcx/XRename.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRename.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,8 +76,8 @@ module com { module sun { module star { module sdbcx { // DocMerge from xml: interface com::sun::star::sdbcx::XRename -/** supports the renaming of definition objects. - <br> +/** supports the renaming of definition objects.<br> + This is a very desirable feature which is not supported by all databases. There is no standard SQL statement provided for this feature. */ @@ -98,6 +98,9 @@ interface XRename: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XRowLocate.idl b/offapi/com/sun/star/sdbcx/XRowLocate.idl index 436d23371dd9..d329791e3555 100644 --- a/offapi/com/sun/star/sdbcx/XRowLocate.idl +++ b/offapi/com/sun/star/sdbcx/XRowLocate.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRowLocate.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -95,8 +95,8 @@ interface XRowLocate: com::sun::star::uno::XInterface <p> If the bookmark could not be located, a result set will be positioned - behind the last record.<br> - If the bookmark is invalid or not generated by the current result set, than + after the last record.<br> + If the bookmark is invalid, or not generated by the current result set, then the behaviour is not defined, even an abnormal termination is possible. </p> */ @@ -108,9 +108,9 @@ interface XRowLocate: com::sun::star::uno::XInterface starting at a given bookmark position. - <p> If the bookmark could not be located, a result set will be positioned - behind the last record.<br> - If the bookmark is invalid or not generated by the current result set, than + <p>If the bookmark could not be located, a result set will be positioned + after the last record.<br> + If the bookmark is invalid, or not generated by the current result set, then the behaviour is not defined, even an abnormal termination is possible. </p> */ @@ -124,9 +124,9 @@ interface XRowLocate: com::sun::star::uno::XInterface <p> The bookmarks must apply to the same ResultSet. You cannot reliably - compare bookmarks from different ResultSet, even if they were created from + compare bookmarks from different ResultSets, even if they were created from the same source or statement. <br> - A bookmark that is not valid or incorrectly formed will cause an exception. + A bookmark that is not valid, or incorrectly formed, will cause an exception. </p>@see com::sun::star::sdbcx::CompareBookmark */ long compareBookmarks([in]any first, [in]any second) @@ -151,6 +151,9 @@ interface XRowLocate: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XTablesSupplier.idl b/offapi/com/sun/star/sdbcx/XTablesSupplier.idl index ec08b9d05ed3..bab3531da04d 100644 --- a/offapi/com/sun/star/sdbcx/XTablesSupplier.idl +++ b/offapi/com/sun/star/sdbcx/XTablesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTablesSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,7 +73,7 @@ // DocMerge from xml: interface com::sun::star::sdbcx::XTablesSupplier -/** provides the access to a container of tables, typically used for a database +/** provides for access to a container of tables, typically used for a database definition object. */ interface XTablesSupplier: com::sun::star::uno::XInterface @@ -91,6 +91,9 @@ interface XTablesSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XUser.idl b/offapi/com/sun/star/sdbcx/XUser.idl index 633b48e8bbc8..95e04de1c19a 100644 --- a/offapi/com/sun/star/sdbcx/XUser.idl +++ b/offapi/com/sun/star/sdbcx/XUser.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUser.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,7 +68,7 @@ module com { module sun { module star { module sdbcx { // DocMerge from xml: interface com::sun::star::sdbcx::XUser -/** allows to change a users password. +/** allows for changing a users password. */ interface XUser: XAuthorizable { @@ -86,6 +86,9 @@ interface XUser: XAuthorizable /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XViewsSupplier.idl b/offapi/com/sun/star/sdbcx/XViewsSupplier.idl index b9eee572a5c1..f6aec70ceef7 100644 --- a/offapi/com/sun/star/sdbcx/XViewsSupplier.idl +++ b/offapi/com/sun/star/sdbcx/XViewsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XViewsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,7 +73,7 @@ // DocMerge from xml: interface com::sun::star::sdbcx::XViewsSupplier -/** provides the access to a container of views, typically used for a database +/** provides for access to a container of views, typically used for a database definition object. */ interface XViewsSupplier: com::sun::star::uno::XInterface @@ -91,6 +91,9 @@ interface XViewsSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api |