diff options
| author | Kai Sommerfeld <kso@openoffice.org> | 2001-02-08 13:05:20 +0000 |
|---|---|---|
| committer | Kai Sommerfeld <kso@openoffice.org> | 2001-02-08 13:05:20 +0000 |
| commit | 28dd4c4556d2f970eca6756d4443331e030e9a68 (patch) | |
| tree | 52f09deaaf28c0a28c029364df363a42df4c14cd /offapi/com/sun | |
| parent | ec57e2797d9e5d17a99926ae768126ba65792554 (diff) | |
Updated/reformatted documentation.
Diffstat (limited to 'offapi/com/sun')
36 files changed, 447 insertions, 422 deletions
diff --git a/offapi/com/sun/star/ucb/CachedContentResultSet.idl b/offapi/com/sun/star/ucb/CachedContentResultSet.idl index 2e1058ebef59..69cbccc55d3b 100644 --- a/offapi/com/sun/star/ucb/CachedContentResultSet.idl +++ b/offapi/com/sun/star/ucb/CachedContentResultSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: CachedContentResultSet.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:51 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,7 +83,7 @@ module com { module sun { module star { module ucb { service CachedContentResultSet { - service ContentResultSet; + service com::sun::star::ucb::ContentResultSet; //------------------------------------------------------------------------- /** contains the number of result set rows that should be fethched from @@ -100,12 +100,13 @@ service CachedContentResultSet /** contains the direction for fetching rows from an underlying database. <p>could contain a value of constants group - <type>com::sun::star::sdbc::FetchDirection</type>. + <type scope="com::sun::star::sdbc">FetchDirection</type>. <p>The default value is implementation specific. <p>If you set <var>FetchDirection</var> to UNKNOWN, an implementation - specific <type>com::sun::star::sdbc::FetchDirection</type> will be used. + specific <type scope="com::sun::star::sdbc">FetchDirection</type> will be + used. */ [property] long FetchDirection; }; diff --git a/offapi/com/sun/star/ucb/CachedContentResultSetStub.idl b/offapi/com/sun/star/ucb/CachedContentResultSetStub.idl index a411c0c30f90..1c117dd37f7b 100644 --- a/offapi/com/sun/star/ucb/CachedContentResultSetStub.idl +++ b/offapi/com/sun/star/ucb/CachedContentResultSetStub.idl @@ -2,9 +2,9 @@ * * $RCSfile: CachedContentResultSetStub.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:51 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,7 +84,7 @@ module com { module sun { module star { module ucb { service CachedContentResultSetStub { - service ContentResultSet; + service com::sun::star::ucb::ContentResultSet; //------------------------------------------------------------------------- /** Provides the possibility to get the contents of the columns of several diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl index 0182f4494c4d..47cdeb149c56 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: CachedDynamicResultSet.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-19 16:03:51 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,22 +74,23 @@ module com { module sun { module star { module ucb { //============================================================================= -/** Provides read access to a static or dynamicly changing +/** provides read access to a static or dynamically changing <type>ContentResultSet</type>. - <p>A <type>DynamicResultSet</type> is returned from the open-command with - a <type>XCommandProcessor</type> of the service <type>Content</type>. + <p>For example, a <type>DynamicResultSet</type> is returned from the + open-command executed by an <type>XCommandProcessor</type> of the service + <type>Content</type>. */ service CachedDynamicResultSet { //------------------------------------------------------------------------- - /** Provides remote optimized read access to a static or dynamicly changing - <type>ContentResultSet</type>. + /** Provides remote optimized read access to a static or a dynamically + changing <type>ContentResultSet</type>. - <p>The <type>XResultSet</type>'s given to the listener in the first + <p>The <type>XResultSet</type>s given to the listener in the first notification in the <type>WelcomeDynamicResultSetStruct</type> are - implementations of <type>CachedContentResultSet</type>. + implementations of the <type>CachedContentResultSet</type> service. <p>This interface is required. */ @@ -97,12 +98,13 @@ service CachedDynamicResultSet //------------------------------------------------------------------------- /** provides the initialization of the <type>CachedDynamicResultSet</type> - with a source object. The <parameter>Source</parameter> in <member> - XSourceInitialization::setSource</member> has to be an interface - <type>XDynamicResultSet</type> and an implementation of service <type> - CachedDynamicResultSetStub</type> + with a source object. - This interface is required. + <p>The <var>Source</var> in + <member>XSourceInitialization::setSource</member> has to be an + implementation of service <type>CachedDynamicResultSetStub</type> + + <p>This interface is required. */ interface com::sun::star::ucb::XSourceInitialization; }; diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl index 59064b1affa0..0317d09227da 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl @@ -2,9 +2,9 @@ * * $RCSfile: CachedDynamicResultSetStub.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-19 16:03:51 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,18 +74,19 @@ module com { module sun { module star { module ucb { //============================================================================= -/** Provides read access to a static or dynamicly changing +/** provides read access to a static or dynamicallly changing <type>ContentResultSet</type>. - <p>A <type>DynamicResultSet</type> is returned from the open-command with - a <type>XCommandProcessor</type> of the service <type>Content</type>. + <p>For example, a <type>DynamicResultSet</type> is returned from the + open-command executed by an <type>XCommandProcessor</type> of the service + <type>Content</type>. */ service CachedDynamicResultSetStub { //------------------------------------------------------------------------- /** In Combination with a <type>CachedDynamicResultSet</type> this provides - remote optimized read access to a static or dynamicly changing + remote optimized read access to a static or dynamically changing <type>ContentResultSet</type>. <p>The <type>XResultSet</type>s given to the listener in the first @@ -100,11 +101,11 @@ service CachedDynamicResultSetStub /** provides the initialization of the <type>CachedDynamicResultSetStub</type> with a source object. - <p>The <var>Source</var> in <member>XSourceInitialization::setSource</member> - has to be an interface <type>XDynamicResultSet</type> and an + <p>The <var>Source</var> in + <member>XSourceInitialization::setSource</member> has to be an implementation of service <type>DynamicResultSet</type> - <p>This interface is required. </p> + <p>This interface is required. */ interface com::sun::star::ucb::XSourceInitialization; }; diff --git a/offapi/com/sun/star/ucb/Content.idl b/offapi/com/sun/star/ucb/Content.idl index 401ef17a7b83..78d6b12268ea 100644 --- a/offapi/com/sun/star/ucb/Content.idl +++ b/offapi/com/sun/star/ucb/Content.idl @@ -2,9 +2,9 @@ * * $RCSfile: Content.idl,v $ * - * $Revision: 1.10 $ + * $Revision: 1.11 $ * - * last change: $Author: kso $ $Date: 2001-02-07 12:31:54 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -129,12 +129,12 @@ service Content registered at the content ( the content holds the listeners ) and the implementation of the listener interface holds a reference on the content. If the content shall be released, - <member>XComponent::dispose</member> must be called at the content. - The implementation of this method must call - <member>XEventListener::disposing</member> on the registered - listeners and release the appropriate object references. At the other - hand, the implementation of XEventListener::disposing must release - its appropriate references. + <member scope="com::sun::star::lang">XComponent::dispose</member> must + be called at the content. The implementation of this method must call + <member scope="com::sun::star::lang">XEventListener::disposing</member> + on the registered listeners and release the appropriate object + references. At the other hand, the implementation of + XEventListener::disposing must release its appropriate references. <p>This interface is required. */ @@ -183,23 +183,23 @@ service Content // column instead. <type scope="com::sun::star::sdbc">XRow</type> getPropertyValues - sequence< <type scope="com::sun::star::beans">Property</type> > + sequence< <type scope="com::sun::star::beans">Property</type> > aProps // This command sets property values of the content. // Note: The execution will not be aborted, if there are properties // contained, that are unknown to the content! void setPropertyValues - sequence< <type scope="com::sun::star::beans">PropertyValue</type> > + sequence< <type scope="com::sun::star::beans">PropertyValue</type> < aValues ----------------------------------------------------------------------- Optional commands: ----------------------------------------------------------------------- // For folder objects, this command will return an implementation - // of service com::sun::star::ucb::DynamicContentResultSet. + // of service <type>DynamicContentResultSet</type>. // - // The OpenCommandArgument2 members must be filled as follows: + // The <type>OpenCommandArgument2</type> members must be filled as follows: // // Mode : ALL or FOLDERS or DOCUMENTS. The implementation // of the open command MUST support all these modes! @@ -214,18 +214,17 @@ service Content // be sorted, otherwise it can be left empty. // // The exceution must be aborted by the implementation of this command - // ( by throwing a CommandAbortedException ), if an unsupported open - // mode is requested. - // + // (by throwing a <type>CommandAbortedException</type>), if an + // unsupported mode is requested. <type>XDynamicResultSet</type> <B>open</B> <type>OpenCommandArgument2</type> aOpenCommandArg - // For non-folder objects, the OpenCommandArgument2 struct will be - // prefilled with a data sink object, which will be filled + // For non-folder objects, the <type>OpenCommandArgument2</type> struct + // will be prefilled with a data sink object, which will be filled // with the content data. // - // The OpenCommandArgument2 members must be filled as follows: + // The <type>OpenCommandArgument2</type> members must be filled as follows: // // Mode : DOCUMENT or DOCUMENT_SHARE_DENY_NONE or // DOCUMENT_SHARE_DENY_WRITE. Support for DOCUMENT @@ -237,9 +236,8 @@ service Content // SortingInfo : empty ( ignored ) // // The exceution must be aborted by the implementation of this command - // ( by throwing a CommandAbortedException ), if an unsupported open - // mode is requested. - // + // (by throwing a <type>CommandAbortedException</type>), if an + // unsupported mode is requested. void <B>open</B> <type>OpenCommandArgument2</type> aOpenCommandArg @@ -248,7 +246,7 @@ service Content // when "updating" a POP3-Inbox, the content for that box will get // and store all new objects on the appropriate server. The inserted // contents will be notified by calling - // <member>com::sun::star::ucb::XContent::contentEvent</member>. + // <member>XContent::contentEvent</member>. void <B>update</B> <type>OpenCommandArgument2</type> aOpenCommandArg @@ -259,7 +257,7 @@ service Content // store all new objects and destroy all cached data for objects no // longer existing on the server. The inserted/deleted contents will // be notified by calling - // <member>com::sun::star::ucb::XContent::contentEvent</member>. + // <member>XContent::contentEvent</member>. void <B>synchronize</B> <type>OpenCommandArgument2</type> aOpenCommandArg @@ -269,15 +267,15 @@ service Content <B>close</B> void - // This command deletes an object. If TRUE is passes as parameter, - // the object will be destroyed physically. Otherwise it will will - // be put into trash can, if such a service is available and the - // object to delete supports the command "undelete". + // This command deletes an object. If <TRUE/> is passed as parameter, + // the object will be destroyed physically. Otherwise it will be put + // into trash can, if such a service is available and the object to + // be deleted supports the command "undelete". // On successful completion of this command, the deleted content // must propagate its deletion by notifying a <type>ContentEvent</type> - // - <type>ContentAction::DELETED</type>. Additionally, the contents + // - <member>ContentAction::DELETED</member>. Additionally, the contents // parent must notify a <type>ContentEvent</type> - // - <type>ContentAction::REMOVED</type> + // - <member>ContentAction::REMOVED</member> void <B>delete</B> boolean bDeletePhysically @@ -291,10 +289,10 @@ service Content // (1) This command inserts a new content. It commits the process of // creating a new content via calling another content's method - // <member>com::sun::star::ucb::XContentCreator::createNewContent</member> + // <member>XContentCreator::createNewContent</member> // The command is not called on the content which created the new // content, because the new object already knows where it is to be - // inserted (i.e. Calling "createNewContent" with content type for a + // inserted (i.e. Calling createNewContent with the content type for a // message on a News Group creates a content which internally belongs // to the Outbox. Calling "insert" on that message will result in // posting the article to the appropriate News Group). Not calling @@ -303,21 +301,27 @@ service Content // "delete" is necessary. // On successful completion of this command, the parent of the inserted // content must propagate the change by notifying a - // <type>ContentEvent</type> - <type>ContentAction::INSERTED</type>. + // <type>ContentEvent</type> - <member>ContentAction::INSERTED</member>. // // (2) Additionally this command can be called at any time to overwrite // the data of an existing content. void <B>insert</B> - <type>InsertCommandArgument</type> + <type>InsertCommandArgument</type> aInsertCommandArg // This command searches for subcontents of a content matching the // given search criteria. The command will return an implemenation - // of service com::sun::star::ucb::DynamicContentResultSet. - com::sun::star::ucb::XDynamicResultSet + // of service <type>DynamicContentResultSet</type>. + <type>XDynamicResultSet</type> <B>search</B> <type>SearchCommandArgument</type> aSearchCommandArg + // <b>Important note:</b> A client that wants to transfer data should + // not execute this command, but it should execute the command + // "globalTransfer" at the/ <type>UniversalContentBroker</type> + // instance. This command is able to transfer all kind of content + // supported by that UCB. + // // This command transfers (copies/moves) an object from one location // to another. It must be executed at the folder content representing // the destination of the transfer operation. Note that the @@ -332,11 +336,10 @@ service Content // another folder on the same IMAP server should work, because it can // be implemeted efficiently. If an implementation is not able to // handle a given source URL, it should indicate this by issuing a - // <type>com::sun::star::ucb::InteractiveBadTransferURLException</type> - // interaction request. Source and target folder may be the same when - // doing a move operation. + // <type>InteractiveBadTransferURLException</type> interaction request. + // Source and target folder may be the same when doing a move operation. // - // Transfers without the transfer command are done as follows: + // Transfers without the transfer command can be done as follows: // // 1) Create a new content at the target folder // --> targetContent = target.XContentCreator::createNewContent(...) @@ -349,12 +352,8 @@ service Content // 4) For move operations only: destroy the source content // sourceContent.execute( "delete", ... ) // - // This mechanism should work for all transfer operations, but - // generally it's less efficient than the transfer command. Therefore, - // a client that wants to transfer data should first try to execute - // a transfer command at the target folder. If the excution fails, - // the client must transfer the content using the - // createNew-transferProps-insert sequence described above. + // This mechanism should work for all transfer operations, but generally + // it's less efficient than the transfer command. void <B>transfer</B> <type>TransferInfo</type> aTransferInfo @@ -421,7 +420,7 @@ service Content // fields of a MIME-message, or the document info of an // office document ). For some standard header fields there // are predefined separate properties, like "MessageTo". - sequence< <type>DocumentHeaderField</type> > DocumentHeader + sequence< <type>DocumentHeaderField</type> > DocumentHeader // contains information about the way a folder stores the // contents of (remote) documents. @@ -609,7 +608,8 @@ service Content <p>This interface must be implemented, if the implementation can dynamically change it's property set ( e.g. because it implements - the interface <type>XPropertyContainer</type>. ) + the interface + <type scope="com::sun::star::beans">XPropertyContainer</type>. ) <p>It is recommended to implement this interface. */ @@ -644,9 +644,9 @@ service Content /** provides access to the parent content of this content. <p>The object returned by the implementation of the method - <member>com::sun::star::container::XChild::getParent()</member> must - implement the service <type>Content</type>. If the content is a root - object, an empty interface may be returned. + <member scope="com::sun::star::container">XChild::getParent()</member> + must implement the service <type>Content</type>. If the content is a + root object, an empty interface may be returned. <p>This interface must be implemented by a content which is a (logical) child of a content. diff --git a/offapi/com/sun/star/ucb/ContentProvider.idl b/offapi/com/sun/star/ucb/ContentProvider.idl index 7830a74f7a10..1804b125adf1 100644 --- a/offapi/com/sun/star/ucb/ContentProvider.idl +++ b/offapi/com/sun/star/ucb/ContentProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: ContentProvider.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: kso $ $Date: 2001-02-07 12:31:55 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,8 +82,7 @@ module com { module sun { module star { module ucb { //============================================================================= -/** A <type>ContentProvider</type> provides access to a set of - * <type>Content</type>s. +/** provides access to a set of <type>Content</type>s. */ service ContentProvider { @@ -121,7 +120,7 @@ service ContentProvider will be the original provider. Implementing a content provider proxy can be useful if the creation of the real content provider object shall be deferred for some reason until the first method gets called - on it ( i.e. performance ). + on it (i.e. performance). <p><b>It is highly recommended to support this interface.</b> diff --git a/offapi/com/sun/star/ucb/ContentProviderProxy.idl b/offapi/com/sun/star/ucb/ContentProviderProxy.idl index 66daee6c196b..0b301bd11bf3 100644 --- a/offapi/com/sun/star/ucb/ContentProviderProxy.idl +++ b/offapi/com/sun/star/ucb/ContentProviderProxy.idl @@ -2,9 +2,9 @@ * * $RCSfile: ContentProviderProxy.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,13 +78,14 @@ module com { module sun { module star { module ucb { //============================================================================= -/** A proxy for a content provider. +/** is a proxy for a content provider. */ service ContentProviderProxy { //------------------------------------------------------------------------- - /** gives access to the original content provider behind the proxy. The - implementation will instantiate the real content provider only on + /** gives access to the original content provider behind the proxy. + + <p>The implementation will instantiate the real content provider only on demand using its UNO service name. This will load the content providers implementation code (dynamic library), if not already done. */ diff --git a/offapi/com/sun/star/ucb/ContentProviderProxyFactory.idl b/offapi/com/sun/star/ucb/ContentProviderProxyFactory.idl index 75635b3f9ae7..735ab45c1f69 100644 --- a/offapi/com/sun/star/ucb/ContentProviderProxyFactory.idl +++ b/offapi/com/sun/star/ucb/ContentProviderProxyFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: ContentProviderProxyFactory.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,13 +70,13 @@ module com { module sun { module star { module ucb { //============================================================================= -/** A factory for content provider proxy implementations. +/** is a factory for <type>ContentProviderProxy</type> implementations. */ service ContentProviderProxyFactory { //------------------------------------------------------------------------- /** a factory for implementations of service - * <type>com::sun::star::ucb::ContentProviderProxy</type>. + <type>ContentProviderProxy</type>. */ interface com::sun::star::ucb::XContentProviderFactory; }; diff --git a/offapi/com/sun/star/ucb/ContentResultSet.idl b/offapi/com/sun/star/ucb/ContentResultSet.idl index b063bd24a7fb..eca2b69b40c5 100644 --- a/offapi/com/sun/star/ucb/ContentResultSet.idl +++ b/offapi/com/sun/star/ucb/ContentResultSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: ContentResultSet.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-01-31 08:40:57 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -98,19 +98,22 @@ module com { module sun { module star { module ucb { //============================================================================= -/** A <type>ContentResultSet</type> provides access to the children of a - folder content. It can be understand as a table containing a row for - each child. The table columns may contain property values. +/** provides access to the children of a folder content. + + <p>It can be understand as a table containing a row for each child. The + table columns may contain values of properties of the children. */ service ContentResultSet { //------------------------------------------------------------------------- /** must be implemented to make it possible to resolve cyclic object - references ( i.e. between implementation of <type>XPropertySet</type> + references ( i.e. between an implementation of + <type scope="com::sun::star::beans">XPropertySet</type> - which may hold property change listeners - and - <type>XPropertyChangeListener</type> - which may hold the property set ). + <type scope="com::sun::star::beans">XPropertyChangeListener</type> + - which may hold the property set ). - This interface is required. + <p>This interface is required. */ interface com::sun::star::lang::XComponent; @@ -118,7 +121,7 @@ service ContentResultSet example the number of columns of the result set, information on the data types of columns, column names, and more. - This interface is required. + <p>This interface is required. */ interface com::sun::star::sdbc::XResultSetMetaDataSupplier; @@ -126,26 +129,26 @@ service ContentResultSet /** enables travelling through the result set members ( the contents ). This interface mainly provides a cursor for the result set. - Note that every method of this interface implementation additionally + <p>Note that every method of this interface implementation additionally may throw a <type>ResultSetException</type> ( which is derived from - <type>com::sun::star::sdbc::SQLException</type> to be compatible + <type scope="com::sun::star::sdbc">SQLException</type> to be compatible to that interface ). The new exception transports another exception, which indicates the reason for the failure of the method call. - This interface is required. + <p>This interface is required. */ interface com::sun::star::sdbc::XResultSet; //------------------------------------------------------------------------- /** provides access to data of the content the cursor is pointing to. - Note that every method of this interface implementation additionally + <p>Note that every method of this interface implementation additionally may throw a <type>ResultSetException</type> ( which is derived from - <type>com::sun::star::sdbc::SQLException</type> to be compatible + <type scope="com::sun::star::sdbc">SQLException</type> to be compatible to that interface ). The new exception transports another exception, which indicates the reason for the failure of the method call. - This interface is required. + <p>This interface is required. */ interface com::sun::star::sdbc::XRow; @@ -153,74 +156,71 @@ service ContentResultSet /** makes it possible to abort running activities ( i.e. to cancel retrieving data from a server ). - Note that every method of this interface implementation additionally + <p>Note that every method of this interface implementation additionally may throw a <type>ResultSetException</type> ( which is derived from - <type>com::sun::star::sdbc::SQLException</type> to be compatible + <type scope="com::sun::star::sdbc">SQLException</type> to be compatible to that interface ). The new exception transports another exception, which indicates the reason for the failure of the method call. - This interface is required. + <p>This interface is required. */ interface com::sun::star::sdbc::XCloseable; //------------------------------------------------------------------------- /** holds properties of the resultset. - This interface is required. + <p>This interface is required. */ interface com::sun::star::beans::XPropertySet; + //------------------------------------------------------------------------- /** controls the travel mode of the resultset cursor. - <p> - There are two possible travel modes: - </p> + <p>There are two possible travel modes: - <table border=1> - <tr><td><type>BLOCKING</type></td> + <p><table border=1> + <tr><td><member>CursorTravelMode::BLOCKING</member></td> <td>Each travel method of the resultset will not return until the data for the new position were retrieved.</td></tr> - <tr><td><type>NONBLOCKING</type></td> + <tr><td><member>CursorTravelMode::NONBLOCKING</member></td> <td>The implementation will throw a <type>CursorWouldBlockException</type>, if the data for the new position are not retrieved yet.</td></tr> </table> - <p> - The following pseudo-code illustrates the usage of a non-blocking + <p>The following pseudo-code illustrates the usage of a non-blocking cursor: - </p> - <pre> - bProcessedAllRows = false - while ( !bProcessedAllRows ) - { - cursor.setPropertyValue( "CursorTravelMode", BLOCKING ) + <p><pre> + bProcessedAllRows = false + while ( !bProcessedAllRows ) + { + cursor.setPropertyValue( "CursorTravelMode", BLOCKING ) - cursor.travelSomeWhere() - collectRowData() + cursor.travelSomeWhere() + collectRowData() - cursor.setPropertyValue( "CursorTravelMode", NONBLOCKING ) + cursor.setPropertyValue( "CursorTravelMode", NONBLOCKING ) - bGoOn = true; - while ( bGoOn ) - { - try - { - cursor.travelSomeWhere() - collectRowData() - } - catch ( CursorWouldBlockException ) + bGoOn = true; + while ( bGoOn ) { - // No more data at the moment. - bGoOn = false + try + { + cursor.travelSomeWhere() + collectRowData() + } + catch ( CursorWouldBlockException ) + { + // No more data at the moment. + bGoOn = false + } } - } - doSomethingWithCollectedRowData() + doSomethingWithCollectedRowData() - bProcessedAllRows = ... - } + bProcessedAllRows = ... + } </pre> <p> @@ -230,10 +230,10 @@ service ContentResultSet <p> The implementation initially needs to set the value of this property - to <type>BLOCKING</type>. + to <member>CursorTravelMode::BLOCKING</member>. </p> - @see com::sun::star::ucb::CursorTravelMode + @see CursorTravelMode */ [optional, property] long CursorTravelMode; @@ -247,7 +247,7 @@ service ContentResultSet /** provides access to the content identifier and the content object itself. - This interface is required. + <p>This interface is required. */ interface XContentAccess; @@ -255,7 +255,7 @@ service ContentResultSet /** can be implemented to provide a complete JDBC conform result set interface for the implementation of this service. - The implememtation of this service is optional. + <p>The implememtation of this service is optional. */ service com::sun::star::sdbc::ResultSet; }; diff --git a/offapi/com/sun/star/ucb/DynamicResultSet.idl b/offapi/com/sun/star/ucb/DynamicResultSet.idl index 0e449ec6ccb6..a9de76c1518c 100644 --- a/offapi/com/sun/star/ucb/DynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/DynamicResultSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: DynamicResultSet.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,17 +70,18 @@ module com { module sun { module star { module ucb { //============================================================================= -/** Provides read access to a static or dynamicly changing +/** provides read access to a static or dynamically changing <type>ContentResultSet</type>. - <p>A <type>DynamicResultSet</type> is returned from the open-command with - a <type>XCommandProcessor</type> of the service <type>Content</type>. + <p>For example, a <type>DynamicResultSet</type> is returned from the + open-command executed by an <type>XCommandProcessor</type> of the service + <type>Content</type>. */ service DynamicResultSet { //------------------------------------------------------------------------- - /** Provides read access to a static or dynamicly changing + /** Provides read access to a static or a dynamically changing <type>ContentResultSet</type>. <p>This interface is required. diff --git a/offapi/com/sun/star/ucb/HierarchyContentProvider.idl b/offapi/com/sun/star/ucb/HierarchyContentProvider.idl index b3e4563ff6a5..d51779cba75b 100644 --- a/offapi/com/sun/star/ucb/HierarchyContentProvider.idl +++ b/offapi/com/sun/star/ucb/HierarchyContentProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: HierarchyContentProvider.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: kso $ $Date: 2001-01-08 10:53:34 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,12 +70,13 @@ module com { module sun { module star { module ucb { //============================================================================= -/** The Hierarchy Content Provider (HCP) implements a Content Provider - for the Universal Content Broker (UCB). It provides access to a persistent, - customizable hierarchy of contents (folders and links). +/** The Hierarchy Content Provider (HCP) implements a + <type>ContentProvider</type> for the <type>UniversalContentBroker</type> + (UCB). + + <p>It provides access to a persistent, customizable hierarchy of contents + (folders and links). - @see com::sun::star::ucb::UniversalContentBroker - @see com::sun::star::ucb::ContentProvider @see com::sun::star::ucb::Content */ service HierarchyContentProvider @@ -88,40 +89,38 @@ service HierarchyContentProvider <b>HCP Contents</b> <ol> <li> - A HCP Link is a content which points to another (UCB) content. - It is always contained in HCP Folder. A HCP Link has no children. - - See <type>HierarchyLinkContent</type> - + A HCP Link (<type>HierarchyLinkContent</type>) is a content which + points to another (UCB) content. It is always contained in HCP Folder. + A HCP Link has no children. </li> <li> - A HCP Folder is a container for other HCP Folders and HCP Links. - - See <type>HierarchyFolderContent</type> - + A HCP Folder (<type>HierarchyFolderContent</type>) is a container for + other HCP Folders and HCP Links. </li> <li> - There is at most one instance of a HCP Root Folder at a time. + There is at most one instance of a HCP Root Folder + ( <type>HierarchyRootFolderContent</type> ) at a time. All other HCP contents are children of this folder. The HCP Root Folder can contain HCP Folders and HCP Links. It has the URL "vnd.sun.star.hier:/". - - See <type>HierarchyRootFolderContent</type> - </li> </ol> - <b>URL Scheme for HCP Contents</b> + <p><b>URL Scheme for HCP Contents</b> - Each HCP content has an identifier corresponding to the following + <p>Each HCP content has an identifier corresponding to the following scheme: - vnd.sun.star.hier:/<path> - - where <path> is a hierarchical path of the form <name>/.../<name> - where <name> is a string encoded according to the URL conventions. + <ul> + <li> + vnd.sun.star.hier:/<path>, where <path> is a + hierarchical path of the form <name>/.../<name> and + where <name> is a string encoded according to the URL + conventions. + </li> + </ul> - Examples: + <p>Examples: <ul> <li> diff --git a/offapi/com/sun/star/ucb/HierarchyFolderContent.idl b/offapi/com/sun/star/ucb/HierarchyFolderContent.idl index 05b90873b4c9..254089212f98 100644 --- a/offapi/com/sun/star/ucb/HierarchyFolderContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyFolderContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: HierarchyFolderContent.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: kso $ $Date: 2001-01-08 10:53:34 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -153,6 +153,7 @@ service HierarchyFolderContent </li> <li> transfer ( only transfers from one hierarchy folder to another supported ) + </li> </ul> <b>Supported Properties</b> @@ -217,7 +218,7 @@ service HierarchyFolderContent <ol> <li> Let the parent folder create a new content by calling - <method>XContentCreator::createNewContent</method> on it. The content + <member>XContentCreator::createNewContent</member> on it. The content type to use for new folders is "application/vnd.sun.star.hier-folder". To create a new link, use the type "application/vnd.sun.star.hier-link". </li> diff --git a/offapi/com/sun/star/ucb/HierarchyLinkContent.idl b/offapi/com/sun/star/ucb/HierarchyLinkContent.idl index 2d0ab43cccee..5ae8c9ada23d 100644 --- a/offapi/com/sun/star/ucb/HierarchyLinkContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyLinkContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: HierarchyLinkContent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: kso $ $Date: 2001-01-09 16:02:27 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -99,7 +99,8 @@ module com { module sun { module star { module ucb { //============================================================================= /** A HCP Link is a content which points to another location. - It is always contained in HCP Folder. A HCP Link has no children. + + <p>It is always contained in HCP Folder. A HCP Link has no children. @see com::sun::star::ucb::HierarchyContentProvider @see com::sun::star::ucb::HierarchyRootFolderContent @@ -145,6 +146,7 @@ service HierarchyLinkContent <li> delete </li> + </ul> <b>Supported Properties</b> <ul> diff --git a/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl b/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl index e811b4b4cd4a..d2e257f3ed67 100644 --- a/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: HierarchyRootFolderContent.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: kso $ $Date: 2001-01-08 10:53:34 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -103,8 +103,10 @@ module com { module sun { module star { module ucb { //============================================================================= /** A HCP Root Folder is the root container for all other HCP Folders and HCP - Links. It always has the URL "vnd.sun.star.hier:/". A HCP Root Folder - neither can't be created nor deleted by a UCB client. + Links. + + <p>It always has the URL "vnd.sun.star.hier:/". A HCP Root Folder neither + can't be created nor deleted by a UCB client. @see com::sun::star::ucb::HierarchyContentProvider @see com::sun::star::ucb::HierarchyFolderContent @@ -149,6 +151,7 @@ service HierarchyRootFolderContent </li> <li> transfer ( only transfers from one hierarchy folder to another supported ) + </li> </ul> <b>Supported Properties</b> @@ -213,7 +216,7 @@ service HierarchyRootFolderContent <ol> <li> Let the parent folder create a new content by calling - <method>XContentCreator::createNewContent</method> on it. The content + <member>XContentCreator::createNewContent</member> on it. The content type to use for new folders is "application/vnd.sun.star.hier-folder". To create a new link, use the type "application/vnd.sun.star.hier-link". </li> diff --git a/offapi/com/sun/star/ucb/OpenCommandArgument.idl b/offapi/com/sun/star/ucb/OpenCommandArgument.idl index 7103f2d9c364..2a8e9e2c5e77 100644 --- a/offapi/com/sun/star/ucb/OpenCommandArgument.idl +++ b/offapi/com/sun/star/ucb/OpenCommandArgument.idl @@ -2,9 +2,9 @@ * * $RCSfile: OpenCommandArgument.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: kso $ $Date: 2000-11-22 15:02:46 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,19 +90,19 @@ struct OpenCommandArgument //------------------------------------------------------------------------- /** The data sink to write the contents into ( supporting either - <type>com::sun::star::io::XActiveDataSink</type> or - <type>com::sun::star::io::XOutputStream</type> ). This gives the + <type scope="com::sun::star::io">XActiveDataSink</type> or + <type scope="com::sun::star::io">XOutputStream</type> ). This gives the caller read-only access to the contents. The data streamer, of type - <type>com::sun::star::io::XActiveDataStreamer</type>, providing both - read and write access to the contents. + <type scope="com::sun::star::io">XActiveDataStreamer</type>, providing + both read and write access to the contents. If an XActiveDataSink is supplied, the implementation of the command needs to provide an implementation of an object implementing the - interface <type>com::sun::star::io::XInputStream</type>. It is + interface <type scope="com::sun::star::io">XInputStream</type>. It is highly recommended that this object also implements the interface - <type>com::sun::star::io::XSeekable</type>, if this can be done + <type scope="com::sun::star::io">XSeekable</type>, if this can be done without wasting resources ( i.e. allocating huge memory buffers ). The implementation object has to be supplied to the data sink. */ @@ -111,7 +111,7 @@ struct OpenCommandArgument //------------------------------------------------------------------------- /** The properties, for that the values shall be provided through the result set of the command ( Usually the result will be of type - <type>com::sun::star::sdbc::XResultSet</type> ). + <type scope="com::sun::star::sdbc">XResultSet</type> ). */ sequence< com::sun::star::beans::Property > Properties; }; diff --git a/offapi/com/sun/star/ucb/PackageContentProvider.idl b/offapi/com/sun/star/ucb/PackageContentProvider.idl index 404e27131b4d..d533bc62acf0 100644 --- a/offapi/com/sun/star/ucb/PackageContentProvider.idl +++ b/offapi/com/sun/star/ucb/PackageContentProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: PackageContentProvider.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: kso $ $Date: 2001-01-10 08:51:30 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,12 +70,12 @@ module com { module sun { module star { module ucb { //============================================================================= -/** The Package Content Provider (PCP) implements a Content Provider - for the Universal Content Broker (UCB). It provides access to packages, - ( zip / jar archive files ) containing folders and streams. +/** The Package Content Provider (PCP) implements a <type>ContentProvider</type> + for the <type>UniversalContentBroker</type> (UCB). + + <p>It provides access to packages ( zip / jar archive files ) containing + folders and streams. - @see com::sun::star::ucb::UniversalContentBroker - @see com::sun::star::ucb::ContentProvider @see com::sun::star::ucb::Content */ service PackageContentProvider @@ -88,23 +88,19 @@ service PackageContentProvider <b>PCP Contents</b> <ol> <li> - A PCP Stream is a content which represents a file inside a package. - It is always contained in a PCP Folder. A PCP Stream has no children. - - See <type>PackageStreamContent</type> - + A PCP Stream (<type>PackageStreamContent</type>) is a content which + represents a file inside a package. It is always contained in a PCP + Folder. A PCP Stream has no children. </li> <li> - A PCP Folder is a container for other PCP Folders and PCP Streams. - - See <type>PackageFolderContent</type> - + A PCP Folder (<type>PackageFolderContent</type>) is a container for + other PCP Folders and PCP Streams. </li> </ol> - <b>URL Scheme for PCP Contents</b> + <p><b>URL Scheme for PCP Contents</b> - Each HCP content has an identifier corresponding to the following + <p>Each HCP content has an identifier corresponding to the following scheme: <ul> @@ -139,7 +135,7 @@ service PackageContentProvider </li> </ul> - Examples: + <p>Examples: <ul> <li> diff --git a/offapi/com/sun/star/ucb/PackageFolderContent.idl b/offapi/com/sun/star/ucb/PackageFolderContent.idl index 337ec26da87e..a766209755a9 100644 --- a/offapi/com/sun/star/ucb/PackageFolderContent.idl +++ b/offapi/com/sun/star/ucb/PackageFolderContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: PackageFolderContent.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: kso $ $Date: 2001-01-15 13:24:04 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -234,7 +234,7 @@ service PackageFolderContent <ol> <li> Let the parent folder create a new content by calling - <method>XContentCreator::createNewContent</method> on it. The content + <member>XContentCreator::createNewContent</member> on it. The content type to use for new folders is "application/vnd.sun.star.pkg-folder". To create a new PCP Stream, use the type "application/vnd.sun.star.pkg-stream". @@ -247,8 +247,9 @@ service PackageFolderContent <li> Let the new child ( not the parent! ) execute the command "insert". This will commit the creation process. For streams, you need to supply - the implementation of an <type>com::sun::star::io::XInputStream</type> - with the command's parameters, that provides access to the stream data. + the implementation of an + <type scope="com::sun::star::io">XInputStream</type> with the command's + parameters, that provides access to the stream data. </li> </ol> @@ -259,7 +260,8 @@ service PackageFolderContent the URL for the new content ( last part of the path will become the title of the new stream ) and to obtain a Content object for that URL from the UCB. Then let the content execute the command "insert". The - command will fail, if you set the command's parameter "ReplaceExisting" + command will fail, if you set the command's parameter + <member>InsertCommandArgument::ReplaceExisting"</member> to false and there is already a stream with the title given by the content's URL. diff --git a/offapi/com/sun/star/ucb/PackageStreamContent.idl b/offapi/com/sun/star/ucb/PackageStreamContent.idl index 257794f442c7..b3bd256fc9b7 100644 --- a/offapi/com/sun/star/ucb/PackageStreamContent.idl +++ b/offapi/com/sun/star/ucb/PackageStreamContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: PackageStreamContent.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: kso $ $Date: 2001-01-15 13:24:04 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -98,8 +98,9 @@ module com { module sun { module star { module ucb { //============================================================================= -/** A PCP Stream is a content which represents a file inside a package. It is - always contained in a PCP Folder. A PCP Stream has no children. +/** A PCP Stream is a content which represents a file inside a package. + + <p>It is always contained in a PCP Folder. A PCP Stream has no children. @see com::sun::star::ucb::PackageContentProvider @see com::sun::star::ucb::PackageFolderContent diff --git a/offapi/com/sun/star/ucb/SearchCommandArgument.idl b/offapi/com/sun/star/ucb/SearchCommandArgument.idl index 3b9b47c9e995..21c952d24205 100644 --- a/offapi/com/sun/star/ucb/SearchCommandArgument.idl +++ b/offapi/com/sun/star/ucb/SearchCommandArgument.idl @@ -2,9 +2,9 @@ * * $RCSfile: SearchCommandArgument.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,7 +90,7 @@ struct SearchCommandArgument //------------------------------------------------------------------------- /** The properties for which values shall be provided through the result set of the command. (Usually, the result will be of type - <type>com::sun::star::sdbc::XResultSet</type>.) + <type scope="com::sun::star::sdbc">XResultSet</type>.) */ sequence< com::sun::star::beans::Property > Properties; }; diff --git a/offapi/com/sun/star/ucb/Store.idl b/offapi/com/sun/star/ucb/Store.idl index 83dd32890aab..bc5936f11972 100644 --- a/offapi/com/sun/star/ucb/Store.idl +++ b/offapi/com/sun/star/ucb/Store.idl @@ -2,9 +2,9 @@ * * $RCSfile: Store.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,13 +70,13 @@ module com { module sun { module star { module ucb { //============================================================================= -/** The <type>Store</type> one-instance service - creates implementations of the interface XPropertySetRegistry. +/** creates implementations of the service <typePropertySetRegistry</type>. */ service Store { //------------------------------------------------------------------------- - /** A factory for propertyset registries. + /** A factory for propertyset registries. This factory must create + implementations of the service <typePropertySetRegistry</type> */ interface com::sun::star::ucb::XPropertySetRegistryFactory; }; diff --git a/offapi/com/sun/star/ucb/TransferInfo.idl b/offapi/com/sun/star/ucb/TransferInfo.idl index eec6fd0f737d..ebd8551d68e2 100644 --- a/offapi/com/sun/star/ucb/TransferInfo.idl +++ b/offapi/com/sun/star/ucb/TransferInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: TransferInfo.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -103,8 +103,7 @@ struct TransferInfo to be transferred to a folder already containing another file named "foo.txt". - Refer to <type>com::sun::star::ucb::NameClash</type> for possible - values. + <p>Refer to <type>NameClash</type> for possible values. */ long NameClash; diff --git a/offapi/com/sun/star/ucb/UniversalContentBroker.idl b/offapi/com/sun/star/ucb/UniversalContentBroker.idl index 26f86db58864..2fd796eb5eae 100644 --- a/offapi/com/sun/star/ucb/UniversalContentBroker.idl +++ b/offapi/com/sun/star/ucb/UniversalContentBroker.idl @@ -2,9 +2,9 @@ * * $RCSfile: UniversalContentBroker.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: kso $ $Date: 2001-02-07 12:58:22 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,13 +90,12 @@ module com { module sun { module star { module ucb { //============================================================================= -/** The <type>UniversalContentBroker</type> is a one-instance service that - provides access to a set of <type>Content</type>s via - <type>ContentProvider</type>s. +/** is a one-instance service that provides access to a set of + <type>Content</type>s via <type>ContentProvider</type>s. - <p>If the instance is created with two arguments of type <type>string</type>, - these two strings are used to configure the newly instantiated broker; see - the description of the required + <p>If the instance is created with two arguments of type + <type>string</type>, these two strings are used to configure the newly + instantiated broker; see the description of the required <type scope="com::sun::star::lang">XInitialization</type> interface for details. @@ -112,13 +111,14 @@ service UniversalContentBroker <p>Those references i.e. may occure if content provider implementations hold references to the Broker. The Broker itself always holds its providers. If the Broker shall be released, - <member>XComponent::dispose</member> must be called at the Broker. - The implementation of this method must call - <member>XEventListener::disposing</member> on the registered listeners - ( the providers holding the Broker must be those listeners ) and - release the appropriate object references. At the other hand, the - implementation of XEventListener::disposing must release its - appropriate references. + <member scope="com::sun::star::lang">XComponent::dispose</member> + must be called at the Broker. The implementation of this method must + call + <member scope="com::sun::star::lang">XEventListener::disposing</member> + on the registered listeners ( the providers holding the Broker must be + those listeners ) and release the appropriate object references. At + the other hand, the implementation of XEventListener::disposing must + release its appropriate references. <p>This interface is required. */ @@ -151,7 +151,7 @@ service UniversalContentBroker /** supports the configuration of a newly created broker. <p>The - <method scope="com::sun::star::lang::XInitialization">initialize</method> + <member scope="com::sun::star::lang"XInitialization::initialize</member> method should be called with two arguments of type <type>string</type>. These strings are used as a pair of keys to retrieve a set of content provider descriptions from the configuration @@ -162,15 +162,15 @@ service UniversalContentBroker provider services at the broker. <p>Typical values for the pair of strings would be - <code>"Local"</code>/<code>"UniversalContentBroker"</code>, to - configure a broker that contains all the relevant content providers. + <code>"Local"</code>/<code>"Office"</code>, to configure a broker that + contains all the relevant content providers. <p>This interface is required. */ interface com::sun::star::lang::XInitialization; //------------------------------------------------------------------------- - /** enables the caller to let the Content Broker execute commands. + /** enables the caller to execute commands at the broker. <p>This interface is required. @@ -199,7 +199,8 @@ service UniversalContentBroker // The implementation must be able to handle Contents provided // by any Content Provider. This is different from the command // 'transfer' that can be supported by a Content. That command - // typically can only handle Contents provided by one Content Provider. + // typically can only handle <type>Content</type>s provided by one + // <type>ContentProvider</type>. void globalTransfer diff --git a/offapi/com/sun/star/ucb/WebDAVContentProvider.idl b/offapi/com/sun/star/ucb/WebDAVContentProvider.idl index e68fb7269ac5..540189d26e50 100644 --- a/offapi/com/sun/star/ucb/WebDAVContentProvider.idl +++ b/offapi/com/sun/star/ucb/WebDAVContentProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: WebDAVContentProvider.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: kso $ $Date: 2001-01-10 13:09:39 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,15 +70,14 @@ module com { module sun { module star { module ucb { //============================================================================= -/** The WebDAV Content Provider (DCP) implements a Content Provider - for the Universal Content Broker (UCB). It provides access to WebDAV - and standard HTTP servers. The DCP communicates with the server using - the <a href="www.webdav.org">WebDAV</a> protocol which is an extention - to the HTTP protocol or using the plain HTTP protocol in case the server - is not WebDAV enabled. - - @see com::sun::star::ucb::UniversalContentBroker - @see com::sun::star::ucb::ContentProvider +/** The WebDAV Content Provider (DCP) implements a <type>ContentProvider</type> + for the <type>UniversalContentBroker</type> (UCB). + + <p>It provides access to WebDAV and standard HTTP servers. The DCP + communicates with the server using the <a href="www.webdav.org">WebDAV</a> + protocol which is an extention to the HTTP protocol or using the plain HTTP + protocol in case the server is not WebDAV enabled. + @see com::sun::star::ucb::Content */ service WebDAVContentProvider @@ -93,41 +92,40 @@ service WebDAVContentProvider <b>DCP Contents</b> <ol> <li> - A DCP Folder is a container for other DCP Folders or Documents. - - See <type>WebDAVFolderContent</type> - + A DCP Folder (<type>WebDAVFolderContent</type>) is a container for + other DCP Folders or Documents. </li> <li> - A DCP Document is a container for Document data/content. The - data/content may be anything, a WebDAV server, like an HTTP server, - does not necessarily mandate what type of data/content may be - contained within Documents. The type of data/content is defined by - the MediaType property which is different from the content type - returned from the getContentType method. The MediaType property is + A DCP Document (<type>WebDAVDocumentContent</type>) is a container for + Document data/content. The data/content may be anything, a WebDAV + server, like an HTTP server, does not necessarily mandate what type of + data/content may be contained within Documents. The type of data/content + is defined by the MediaType property which is different from the content + type returned from the getContentType method. The MediaType property is mapped to the equivalent WebDAV property and the WebDAV server calculates the value. - - See <type>WebDAVDocumentContent</type> - </li> </ol> - <b>URL Scheme for DCP Contents</b> + <p><b>URL Scheme for DCP Contents</b> - Each DCP content has an identifier corresponding to the following + <p>Each DCP content has an identifier corresponding to the following scheme: - vnd.sun.star.webdav://host:port/<path> - - where <path> is a hierarchical path of the form <name>/.../<name> - where <name> is a string encoded according to the URL conventions. + <ul> + <li> + vnd.sun.star.webdav://host:port/<path> where <path> is + a hierarchical path of the form <name>/.../<name> and + where <name> is a string encoded according to the URL + conventions. + </li> + </ul> - It is also possible to use standard HTTP-URLs. In this case the + <p>It is also possible to use standard HTTP-URLs. In this case the implementation will determine by itself, if the requested resource is DAV enabled. - Examples: + <p>Examples: <ul> <li> diff --git a/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl b/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl index ca2fdb6e5a87..724241807fad 100644 --- a/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl +++ b/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: WebDAVDocumentContent.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: kso $ $Date: 2001-01-10 13:09:39 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -98,13 +98,15 @@ module com { module sun { module star { module ucb { //============================================================================= -/** A DCP Document is a container for Document data/content. The data/content - may be anything, a WebDAV server, like an HTTP server, does not necessarily - mandate what type of data/content may be contained within Documents. - The type of data/content is defined by the MediaType property which is - different from the content type returned from the getContentType method. - The MediaType property is mapped to the equivalent WebDAV property and - the WebDAV server calculates the value. +/** A DCP Document is a container for Document data/content. + + <p>The data/content may be anything, a WebDAV server, like an HTTP server, + does not necessarily mandate what type of data/content may be contained + within Documents. The type of data/content is defined by the MediaType + property which is different from the content type returned from the + <member>XContent::getContentType</member> method. The MediaType property + is mapped to the equivalent WebDAV property and the WebDAV server calculates + the value. @see com::sun::star::ucb::WebDAVContentProvider @see com::sun::star::ucb::WebDAVFolderContent diff --git a/offapi/com/sun/star/ucb/WebDAVFolderContent.idl b/offapi/com/sun/star/ucb/WebDAVFolderContent.idl index 62670b63d640..84373aef072d 100644 --- a/offapi/com/sun/star/ucb/WebDAVFolderContent.idl +++ b/offapi/com/sun/star/ucb/WebDAVFolderContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: WebDAVFolderContent.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: kso $ $Date: 2001-01-10 13:09:39 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -230,7 +230,7 @@ service WebDAVFolderContent <ol> <li> Let the parent folder create a new content by calling - <method>XContentCreator::createNewContent</method> on it. The content + <member>XContentCreator::createNewContent</member> on it. The content type to use for new folders is "application/vnd.sun.star.webdav-collection". To create a new DCP Document, use the type "application/http-content". diff --git a/offapi/com/sun/star/ucb/XAnyCompare.idl b/offapi/com/sun/star/ucb/XAnyCompare.idl index 0188941feb5a..7ffe57e4faa7 100644 --- a/offapi/com/sun/star/ucb/XAnyCompare.idl +++ b/offapi/com/sun/star/ucb/XAnyCompare.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAnyCompare.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,19 +70,33 @@ module com { module sun { module star { module ucb { //============================================================================= -/** Provides a method to compare two <type>any</type>s. +/** compares two <type scope=com:.sun::star::uno">Any</type>s. */ [ uik(C95ED4C1-3B9A-11d4-8B150010-4BCAF449), ident( "XAnyCompare", 1.0 ) ] interface XAnyCompare: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** this method allows a comparision of two anys + /** allows comparision of two <type scope=com:.sun::star::uno">Any</type>s. - the method retuns the following values: - -1, if the first any is smaller than the second ( Any1<Any2 ) + @param Any1 + is the first compare value + + @param Any2 + is the second compare value + + @returns the following values: + <ul> + <li> + -1, if the first any is smaller than the second ( Any1 < Any2 ) + </li> + <li> 0, if the first any is equal to the second ( Any1==Any2 ) - +1, if the first any is greater than the second ( Any1>Any2 ) + </li> + <li> + +1, if the first any is greater than the second ( Any1 > Any2 ) + </li> + </ul> */ short compare( [in] any Any1, [in] any Any2 ); diff --git a/offapi/com/sun/star/ucb/XAnyCompareFactory.idl b/offapi/com/sun/star/ucb/XAnyCompareFactory.idl index e43f3c185869..a974b1c8b532 100644 --- a/offapi/com/sun/star/ucb/XAnyCompareFactory.idl +++ b/offapi/com/sun/star/ucb/XAnyCompareFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAnyCompareFactory.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,18 +78,22 @@ module com { module sun { module star { module ucb { //============================================================================= -/** Provides a methods to create a <type>XAnyCompare</type> for purpose of -comparision of two anys. +/** creates an <type>XAnyCompare</type> instance. */ [ uik(C95ED4C2-3B9A-11d4-8B150010-4BCAF449), ident( "XAnyCompareFactory", 1.0 ) ] interface XAnyCompareFactory: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** provides the creation of a <type>XAnyCompare</type> - dependent on internal data and a propertyname. + /** creates an <type>XAnyCompare</type> instance. + + @param PropertyName + is the name of a property + + @returns + a compare interface */ - com::sun::star::ucb::XAnyCompare createAnyCompareByName( + com::sun::star::ucb::XAnyCompare createAnyCompareByName( [in] string PropertyName ); }; diff --git a/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl b/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl index aa6e1fedce2c..261fe9efd32f 100644 --- a/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCachedContentResultSetFactory.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,25 +78,25 @@ module com { module sun { module star { module ucb { //============================================================================= -/** provides the creation of a remote optimized <type>XResultSet</type>. The -returned interface is a implementations of service -<type>CachedContentResultSet</type>. +/** creates a <type>CachedContentResultSet</type>. */ [ uik(1312DDB1-4EAD-11d4-8B190010-4BCAF449), ident( "XCachedContentResultSetFactory", 1.0 ) ] interface XCachedContentResultSetFactory: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** provides the creation of a remote optimized <type>XResultSet</type>. + /** creates a remote optimized <type>XResultSet</type>. - <p>The returned interface is a implementations of - service <type>CachedContentResultSet</type>. + @param xSource + must be an instance of service <type>CachedContentResultSetStub</type>. - <p>The <paramter>Source</parameter> has to be an implememntation of - service <type>CachedContentResultSetStub</type>. - The <parameter>xMapping</parameter> can be used for optimization - of remote access via the interface <type>XContentAccess</type> of - the <type>CachedContentResultSet</type>. This paramter can also be NULL. + @param xMapping + can be used for optimization of remote access via the interface + <type>XContentAccess</type> of the <type>CachedContentResultSet</type>. + This paramter can be <NULL/>. + + @returns + an instance of service <type>CachedContentResultSet</type>. */ com::sun::star::sdbc::XResultSet createCachedContentResultSet( [in] com::sun::star::sdbc::XResultSet xSource, diff --git a/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl b/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl index 7ece59a91f14..afab96613d35 100644 --- a/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCachedContentResultSetStubFactory.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,22 +74,20 @@ module com { module sun { module star { module ucb { //============================================================================= -/** provides the creation of a remote optimized <type>XResultSet</type>. The -returned interface is a implementations of service -<type>CachedContentResultSetStub</type>. +/** creates a <type>CachedContentResultSetStub</type>. */ [ uik(06A16081-5189-11d4-8B1A0010-4BCAF449), ident( "XCachedContentResultSetStubFactory", 1.0 ) ] interface XCachedContentResultSetStubFactory: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** provides the creation of a remote optimized <type>XResultSet</type>. + /** creates a remote optimized <type>XResultSet</type>. - <p>The returned interface is a implementations of - service <type>CachedContentResultSetStub</type>. + @param xSource + must be an instance of service <type>ContentResultSet</type>. - <p>The <paramter>Source</parameter> has to be an implememntation of - service <type>ContentResultSet</type>. + @returns + an instance of service <type>CachedContentResultSetStub</type>. */ com::sun::star::sdbc::XResultSet createCachedContentResultSetStub( [in] com::sun::star::sdbc::XResultSet xSource ); diff --git a/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl b/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl index 7949f837be51..500e9ab06494 100644 --- a/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCachedDynamicResultSetFactory.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,36 +78,36 @@ module com { module sun { module star { module ucb { //============================================================================= -/** helps to get an remote optimized access for a given <type>DynamicResultSet -</type>. +/** creates a <type>CachedDynamicResultSet</type>. -<p>Pay attention to instanciate this helper on clientside where your want to -read the data respectively where you have instantiated the listener to the -<type>XDynamicResultSet</type>. + <p>Pay attention to instanciate this helper on clientside where your want + to read the data respectively where you have instantiated the listener to + the <type>XDynamicResultSet</type>. -<p>The needed stub on server side you can create with -<type>XCachedDynamicResultSetStubFactory</type>. + <p>The needed stub on server side can be created using + <type>XCachedDynamicResultSetStubFactory</type>. */ [ uik(D5F56011-5298-11d4-8B1B0010-4BCAF449), ident( "XCachedDynamicResultSetFactory", 1.0 ) ] interface XCachedDynamicResultSetFactory: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** provides the creation of a <type>CachedDynamicResultSet</type>. + /** creates a remote optimizes <type>XDynamicResultSet</type>. - <p>The returned interface is a implementations of - service <type>CachedDynamicResultSet</type>. + @param SourceStub + must be an instance of service <type>CachedDynamicResultSetStub</type>. + It can be <NULL/>. In this case you can use the interface + <type>XSourceInitialization</type> of the returned + <type>CachedDynamicResultSet</type> to set the stub later. - <p><paramter>SourceStub</parameter> has to be an implememntation of - service <type>CachedDynamicResultSetStub</type>. It can be NULL also, - in this case you can use the interface <type>XSourceInitialization</type> - of <type>CachedDynamicResultSet</type> to set the stub afterwards. + @param ContentIdentifierMapping + is not required, but can be set if it is necessary to change the + identity of the contents accessable via the interface + <type>XContentAccess</type> of the <type>ContentResultSet</type> + (e.g., if merging two sources of the same type). - <p><parameter>ContentIdentifierMapping</parameter> is not required - but can be set if it is necessary to change the identity of the contents - accessable via the interface <type>XContentAccess</type> of the - <type>ContentResultSet</type> (e.g., if merging two sources of the - same type). + @returns + an instance of service <type>CachedDynamicResultSet</type>. */ com::sun::star::ucb::XDynamicResultSet createCachedDynamicResultSet( [in] com::sun::star::ucb::XDynamicResultSet SourceStub diff --git a/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl index cd5a20883ea8..d592371319ce 100644 --- a/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCachedDynamicResultSetStubFactory.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-19 16:03:51 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,32 +82,35 @@ module com { module sun { module star { module ucb { //============================================================================= -/** helps to get an remote optimized access for a given <type>DynamicResultSet</type>. +/** creates a <type>CachedDynamicResultSetStub</type> and connects a non-remote + optimized <type>DynamicResultSet</type> to a remote optimized + <type>CachedDynamicResultSet</type>. -<p>Pay attention to instanciate this helper on serverside where your source -<type>DynamicResultSet</type> is instabciated. + <p>Pay attention to instanciate this helper on serverside where your source + <type>DynamicResultSet</type> was instanciated. -<p>The first method can be used to create a stub on serverside. + <p>Method <method>createCachedDynamicResultSetStub</method> can be used to + create a stub on serverside. -<p>If you have instanciated a <type>CachedDynamicResultSet</type> on client side already, -use the second <member>connectToCache</member> to connect your given DynamicResultSet -with this Cache. + <p>If you have instanciated a <type>CachedDynamicResultSet</type> on client + side already, use method <member>connectToCache</member> to connect your + given DynamicResultSet with this Cache. -<p>The needed cache on server side you can create with -<type>XCachedDynamicResultSetFactory</type>. + <p>The needed cache on server side you can create using + <type>XCachedDynamicResultSetFactory</type>. */ [ uik(D5F56013-5298-11d4-8B1B0010-4BCAF449), ident( "XCachedDynamicResultSetStubFactory", 1.0 ) ] interface XCachedDynamicResultSetStubFactory: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** provides the creation of a <type>CachedDynamicResultSetStub</type>. + /** creates a remote optimizes <type>XDynamicResultSet</type>. - <p>The returned interface is a implementations of - service <type>CachedDynamicResultSetStub</type>. + @param Source + must be an instance of service <type>DynamicResultSet</type>. - <p>The <paramter>Source</parameter> has to be an implememntation of - service <type>DynamicResultSet</type>. + @returns + an instance of service <type>CachedDynamicResultSetStub</type>. */ com::sun::star::ucb::XDynamicResultSet createCachedDynamicResultSetStub( @@ -118,27 +121,26 @@ interface XCachedDynamicResultSetStubFactory: com::sun::star::uno::XInterface client side already, use this to connect your given Source on server side to the TargetCache. - <p>The <paramter>Source</parameter> has to be an implememntation of - service <type>DynamicResultSet</type>. + @param Source + is an instance of service <type>DynamicResultSet</type>. - <p>The <parameter>TargetCache</parameter> has to be an implememntation - of service <type>CachedDynamicResultSet</type>. + @param TargetCache + is an instance of service <type>CachedDynamicResultSet</type>. - <p>Internal there will be created a <type>CachedDynamicResultSetStub - </type> as stub on server side, but you will not get it ( you will not - need to get it ). + @param SortingInfo + can be an empty sequence. Otherwise, Source will be sorted according + to the given sorting data. - <p>The parameters <parameter>SortingInfo</parameter> and - </parameter>CompareFactory</parameter> don't need to contain data. - If <parameter>SortingInfo</parameter> contains data and your - <parameter>Source</parameter> is not fully sorted until now, it will - be sorted with the given parameters. + @param CompareFactory + will be ignored unless SortingInfo is not empty. Then the supplied + factory will be used to instanciate objects used to compare the + properties that are involved in sorting. - <p>raises <exception>AlreadyInitializedException</exception>, if - <parameter>TargetCache</parameter> was initialized already. + @throws ListenerAlreadySetException + if <member>Source</member> is already in use. - <p>raises <exception>ListenerAlreadySetException</exception>, if - <parameter>Source</parameter> is already in use. + @throws AlreadyInitializedException + if <member>TargetCache</member> already has been initialized. */ void connectToCache( [in] com::sun::star::ucb::XDynamicResultSet Source diff --git a/offapi/com/sun/star/ucb/XContentProviderManager.idl b/offapi/com/sun/star/ucb/XContentProviderManager.idl index 2b8eccd109ec..30797242e07e 100644 --- a/offapi/com/sun/star/ucb/XContentProviderManager.idl +++ b/offapi/com/sun/star/ucb/XContentProviderManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: XContentProviderManager.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: kso $ $Date: 2001-02-08 08:58:14 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -101,7 +101,7 @@ interface XContentProviderManager: com::sun::star::uno::XInterface the content provider to register. <p>This may be <NULL/>, in which case a later - <method>XContentProvider::queryContent</method> with an + <member>XContentProvider::queryContent</metmber> with an <type>XContentIdentifier</type> that matches the <var>Scheme</var> will simply return <NULL/>. These "dummy" content providers are useful in combination with other content providers that are registered on a diff --git a/offapi/com/sun/star/ucb/XDynamicResultSet.idl b/offapi/com/sun/star/ucb/XDynamicResultSet.idl index 034713cc98bb..f24c1a772d42 100644 --- a/offapi/com/sun/star/ucb/XDynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/XDynamicResultSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDynamicResultSet.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-01-31 10:26:49 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -204,7 +204,7 @@ interface XDynamicResultSet: com::sun::star::lang::XComponent <p>This method is not allowed to be called, if someone already has fetched the <type>ContentResultSet</type> via - <method>XDynamicResultSet::getStaticResultSet</method>. + <member>XDynamicResultSet::getStaticResultSet</member>. Otherwise you get the Exception <type>ListenerAlreadySetException</type>. diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl index 7623517f6663..591ad0191002 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRemoteContentProviderAcceptor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-19 16:03:51 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -93,8 +93,7 @@ interface XRemoteContentProviderAcceptor: com::sun::star::uno::XInterface remote content provider. @param Factory A factory through which the remote content provider's - <type>com.sun.star.ucb.ContentProviderBroker</type> service can be - instantiated. + <type>UniversalContentBroker</type> service can be instantiated. @param Templates A sequence of URL templates the remote content provider is willing to handle. diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderDistributor.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderDistributor.idl index 39ce0b4a6758..797c4314a7db 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderDistributor.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderDistributor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRemoteContentProviderDistributor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-15 11:29:29 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,11 +84,11 @@ module com { module sun { module star { module ucb { //============================================================================= /** Distribute a content broker to variuos - <type>com::sun::star::ucb::XRemoteContentProviderAcceptor</type>s. + <type>XRemoteContentProviderAcceptor</type>s. @version 1.0 @author Stephan Bergmann - @see <type>com::sun::star::ucb::XRemoteContentProviderAcceptor</type> + @see XRemoteContentProviderAcceptor */ [ uik(F0C3B390-655E-11D4-9FB50050-04526AAD), ident("XRemoteContentProviderDistributor", 1.0) ] interface XRemoteContentProviderDistributor: com::sun::star::uno::XInterface @@ -97,14 +97,14 @@ interface XRemoteContentProviderDistributor: com::sun::star::uno::XInterface /** Offer the local content broker to a remote content provider acceptor. <p> The Uno Url is handed to the - <type>com.sun.star.bridge.UnoUrlResolver</type> service, which is - responsible for raising any of the advertised exceptions. </p> + <type scope="com::sun::star::bridge">UnoUrlResolver</type> service, + which is responsible for raising any of the advertised exceptions. </p> @param Url A Uno Url to address the - <type>com::sun::star::ucb::XRemoteContentProviderAcceptor</type>. + <type>XRemoteContentProviderAcceptor</type>. @param Identifier An identifier handed to the - <type>com::sun::star::ucb::XRemoteContentProviderAcceptor</type>. + <type>XRemoteContentProviderAcceptor</type>. @returns success indicator. Escpecially, if there's already a connection to the given Url, the call will fail, no matter whether @@ -121,7 +121,7 @@ interface XRemoteContentProviderDistributor: com::sun::star::uno::XInterface content provider acceptor. @param Url A Uno Url to address the - <type>com::sun::star::ucb::XRemoteContentProviderAcceptor</type>. + <type>XRemoteContentProviderAcceptor</type>. @returns success indicator. */ diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderSupplier.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderSupplier.idl index 063035bb8259..6a9f157826f5 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderSupplier.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRemoteContentProviderSupplier.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,15 +79,14 @@ module com { module sun { module star { module ucb { @version 1.0 @author Stephan Bergmann - @see <type>com::sun::star::ucb::XRemoteContentProviderAcceptor</type> + @see XRemoteContentProviderAcceptor */ [ uik(A271EA70-648D-11D4-9FB40050-04526AAD), ident("XRemoteContentProviderSupplier", 1.0) ] interface XRemoteContentProviderSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** Get a factory through which a remote content provider's - <type>com.sun.star.ucb.ContentProviderBroker</type> service can be - instantiated. + <type>UniversalContentBroker</type> service can be instantiated. @param Identifier An arbitrary identifier uniquely identifying a remote content provider. |