summaryrefslogtreecommitdiff
path: root/offapi
diff options
context:
space:
mode:
authorJoachim Lingner <jl@openoffice.org>2010-06-07 17:03:27 +0200
committerJoachim Lingner <jl@openoffice.org>2010-06-07 17:03:27 +0200
commita42036353ad2a1a8c1b9f1344ad27547786dfd1f (patch)
tree4e3e6ded05cc652afa8486aeaada70918f6f937a /offapi
parentf185517358e1d23504324b08535795dcd3bbff1b (diff)
jl152 #i77196# fixing merge conflicts
Diffstat (limited to 'offapi')
-rw-r--r--offapi/com/sun/star/deployment/ExtensionManager.idl8
-rw-r--r--offapi/com/sun/star/deployment/XExtensionManager.idl54
-rw-r--r--offapi/com/sun/star/deployment/XPackage.idl6
-rw-r--r--offapi/com/sun/star/deployment/XPackageManager.idl5
4 files changed, 32 insertions, 41 deletions
diff --git a/offapi/com/sun/star/deployment/ExtensionManager.idl b/offapi/com/sun/star/deployment/ExtensionManager.idl
index ee93623ce538..1911ce04dd81 100644
--- a/offapi/com/sun/star/deployment/ExtensionManager.idl
+++ b/offapi/com/sun/star/deployment/ExtensionManager.idl
@@ -33,14 +33,12 @@
module com { module sun { module star { module deployment {
-/** <type>thePackageManagerFactory</type> denotes the one and only
- <type>XPackageManagerFactory</type> object to be used.
- <p>
+/** the ExtensionManager service.
+
The component context entry is
<code>
- /singletons/com.sun.star.deployment.thePackageManagerFactory
+ /singletons/com.sun.star.deployment.ExtensionManager
</code>.
- </p>
@since OOo 3.3.0
*/
diff --git a/offapi/com/sun/star/deployment/XExtensionManager.idl b/offapi/com/sun/star/deployment/XExtensionManager.idl
index cfbc71156b7f..b807df54af65 100644
--- a/offapi/com/sun/star/deployment/XExtensionManager.idl
+++ b/offapi/com/sun/star/deployment/XExtensionManager.idl
@@ -41,27 +41,10 @@
module com { module sun { module star { module deployment {
-/** The <type>XExtensionManager</type> interface is used to add or remove
- packages to a specific deployment context.
- Packages are deployable files, e.g. scripts or UNO components.
- <p>
- Adding an UNO package means that a copy of the package is stored
- with respect to the context of the manager and the package is registered,
- thus activated.
- </p>
- <p>
- Removing an UNO package means that the previously added package is revoked,
- thus deactivated, first and then removed from the context.
- </p>
- <p>
- Objects of this interface are created using the
- <type>XPackageManagerFactory</type> service resp. the singleton
- <code>
- /singletons/com.sun.star.deployment.thePackageManagerFactory
- </code>.
- </p>
-
- @see thePackageManagerFactory
+/** The <type>XExtensionManager</type> interface is used to manage extensions
+ in the user, shared and bundled repository.
+
+ @see ExtensionManager
@since OOo 3.3.0
*/
interface XExtensionManager
@@ -90,7 +73,7 @@ interface XExtensionManager
*/
com::sun::star::task::XAbortChannel createAbortChannel();
- /** adds an UNO package.
+ /** adds an extension.
The properties argument is currently only used to suppress the license information
for shared extensions.
@@ -120,7 +103,7 @@ interface XExtensionManager
com::sun::star::ucb::CommandAbortedException,
com::sun::star::lang::IllegalArgumentException);
- /** removes an UNO package.
+ /** removes an extension.
@param identifier
package identifier
@@ -190,7 +173,7 @@ interface XExtensionManager
com::sun::star::ucb::CommandAbortedException,
com::sun::star::lang::IllegalArgumentException);
- /** gets all currently deployed extensions, including disabled
+ /** gets all currently installed extensions, including disabled
user extensions.
@param repository
@@ -201,7 +184,7 @@ interface XExtensionManager
@param xCmdEnv
command environment for error and progress handling
@return
- all currently deployed packages
+ all currently installed packages
*/
sequence<XPackage> getDeployedExtensions(
[in] string repository,
@@ -213,18 +196,18 @@ interface XExtensionManager
com::sun::star::lang::IllegalArgumentException);
- /** gets a deployed extensions.
+ /** gets an installed extensions.
@param repositroy
the name of the repository
@param identifier
- package identifier
+ extension identifier
@param fileName
- package file name
+ extension file name
@param xCmdEnv
command environment for error and progress handling
@return
- <type>XPackage</type> handle
+ <type>XPackage</type> object
*/
XPackage getDeployedExtension(
[in] string repository,
@@ -271,7 +254,7 @@ interface XExtensionManager
/** Expert feature: erases the underlying registry cache and reinstalls
- all previously added packages. Please keep in mind that all
+ all previously added extensions. Please keep in mind that all
registration status get lost.
<p>
Please use this in case of suspected cache inconsistencies only.
@@ -294,7 +277,7 @@ interface XExtensionManager
/** synchronizes the extension database with the contents of the extensions
- folder.
+ folder of shared and bundled extensinos.
Added extensions will be added to the database and removed extensions
will be removed from the database.
@@ -323,6 +306,12 @@ interface XExtensionManager
Extensions which allow the license to be suppressed, that is, it does not
need to be displayed, and which are installed with the corresponding option,
are also not returned.
+
+ Extensions returned by this functions are not returned by
+ <member>XExtensionManger::getDeployedExtension</member>
+ <member>XExtensionManger::getDeployedExtensions</member>
+ <member>XExtensionManger::getAllExtensions</member>
+ <member>XExtensionManger::getExtensionsWithSameIdentifier</member>
*/
sequence<XPackage> getExtensionsWithUnacceptedLicenses(
[in] string repository,
@@ -331,8 +320,7 @@ interface XExtensionManager
com::sun::star::lang::IllegalArgumentException);
/** check if all prerequisites for the extension are fulfilled
- and registeres it if possible.
- See also <member>XPackageManager::checkPrerequisites</member>
+ and activates it, if possible.
*/
long checkPrerequisitesAndEnable(
[in] XPackage extension,
diff --git a/offapi/com/sun/star/deployment/XPackage.idl b/offapi/com/sun/star/deployment/XPackage.idl
index 6d3ae5d91d22..9709b579bc2e 100644
--- a/offapi/com/sun/star/deployment/XPackage.idl
+++ b/offapi/com/sun/star/deployment/XPackage.idl
@@ -137,7 +137,9 @@ interface XPackage
com::sun::star::ucb::CommandFailedException,
com::sun::star::ucb::CommandAbortedException);
- /** registers this <type>XPackage</type>, thus activating the package.
+ /** registers this <type>XPackage</type>.
+
+ NEVER call this directly. This is done by the extension manager if necessary.
@param startup
indicates that registration is adapted to the particular
@@ -161,6 +163,8 @@ interface XPackage
/** revokes this <type>XPackage</type>.
+ NEVER call this directly. This is done by the extension manager if necessary.
+
@param xAbortChannel
abort channel to asynchronously abort the registration process,
or null
diff --git a/offapi/com/sun/star/deployment/XPackageManager.idl b/offapi/com/sun/star/deployment/XPackageManager.idl
index fde1505ffac0..da329bb9367f 100644
--- a/offapi/com/sun/star/deployment/XPackageManager.idl
+++ b/offapi/com/sun/star/deployment/XPackageManager.idl
@@ -55,7 +55,7 @@ module com { module sun { module star { module deployment {
removed from the repository.
</p>
<p>
- All interface methods do neither register or revoke an extension.
+ All interface methods do neither register nor revoke an extension.
This happens exclusively by <type>XExtensionManager</type>.
</p>
<p>
@@ -82,7 +82,8 @@ interface XPackageManager
*/
interface com::sun::star::util::XModifyBroadcaster;
- /** returns the underlying deployment context.
+ /** returns the underlying deployment context, that is,
+ the name of the repository..
@return
underlying deployment context