summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/deployment/XPackage.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/deployment/XPackage.idl')
-rw-r--r--offapi/com/sun/star/deployment/XPackage.idl58
1 files changed, 29 insertions, 29 deletions
diff --git a/offapi/com/sun/star/deployment/XPackage.idl b/offapi/com/sun/star/deployment/XPackage.idl
index 9709b579bc2e..920b27426bc9 100644
--- a/offapi/com/sun/star/deployment/XPackage.idl
+++ b/offapi/com/sun/star/deployment/XPackage.idl
@@ -1,7 +1,7 @@
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
+ *
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
@@ -48,7 +48,7 @@ module com { module sun { module star { module deployment {
/** Objects of this interface reflect a bound package and are issued by a
<type>PackageRegistryBackend</type>.
-
+
@since OOo 2.0.0
*/
interface XPackage
@@ -56,19 +56,19 @@ interface XPackage
/** implemented to notify that the package has been removed
*/
interface com::sun::star::lang::XComponent;
-
+
/** notifies changes of the registration state of the package
*/
interface com::sun::star::util::XModifyBroadcaster;
-
+
/** creates a command channel to be used to asynchronously abort a command.
-
+
@return
abort channel
*/
com::sun::star::task::XAbortChannel createAbortChannel();
-
+
/** checks if the package can be installed.
Only if the return value is true the package is allowed to be installed.
@@ -76,7 +76,7 @@ interface XPackage
completely.
After return of this function no code from the extension may be used
anymore, so that the extension can be safely removed from the harddisk.
-
+
@param xCmdEnv
command environment for error handling and other interaction.
@alreadyInstalled
@@ -94,12 +94,12 @@ interface XPackage
ExtensionRemovedException,
com::sun::star::ucb::CommandFailedException,
com::sun::star::ucb::CommandAbortedException);
-
+
/** checks if the dependencies for this package are still satisfied
After updateing the OpenOffice.org, some dependencies for packages might
no longer be satisfied.
-
+
@since OOo 3.2.0
@param xCmdEnv
@@ -114,11 +114,11 @@ interface XPackage
raises (DeploymentException,
ExtensionRemovedException,
com::sun::star::ucb::CommandFailedException);
-
+
/** determines whether the package is currently is registered, i.e.
whether it is active.
-
+
@param xAbortChannel
abort channel to asynchronously abort the registration process,
or null
@@ -136,7 +136,7 @@ interface XPackage
raises (DeploymentException,
com::sun::star::ucb::CommandFailedException,
com::sun::star::ucb::CommandAbortedException);
-
+
/** registers this <type>XPackage</type>.
NEVER call this directly. This is done by the extension manager if necessary.
@@ -160,11 +160,11 @@ interface XPackage
com::sun::star::ucb::CommandFailedException,
com::sun::star::ucb::CommandAbortedException,
com::sun::star::lang::IllegalArgumentException);
-
+
/** 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
@@ -178,15 +178,15 @@ interface XPackage
com::sun::star::ucb::CommandFailedException,
com::sun::star::ucb::CommandAbortedException,
com::sun::star::lang::IllegalArgumentException);
-
+
/** reflects whether this package is a bundle of one or more packages,
e.g. a zip (legacy) package file or a document hosting script packages.
-
+
@return
in case this package relfects a package bundle
*/
boolean isBundle();
-
+
/** Gets packages of the bundle.
If <member>isRemoved</member> returns true then getBundle may return an
@@ -207,7 +207,7 @@ interface XPackage
com::sun::star::ucb::CommandFailedException,
com::sun::star::ucb::CommandAbortedException,
com::sun::star::lang::IllegalArgumentException);
-
+
/** returns the file name of the package.
@return
@@ -237,25 +237,25 @@ interface XPackage
*/
string getVersion()
raises (ExtensionRemovedException);
-
+
/** returns the location of the package.
-
+
@return
location of package
*/
string getURL();
-
+
/** returns the display name of the package, e.g. for graphical user
interfaces (GUI).
-
+
@return
display name of the package
*/
string getDisplayName()
raises (ExtensionRemovedException);
-
+
/** returns a description string to describe the package.
-
+
@return
description
*/
@@ -285,14 +285,14 @@ interface XPackage
::com::sun::star::beans::StringPair getPublisherInfo()
raises (ExtensionRemovedException);
/** returns the <type>XPackageTypeInfo</type>, e.g. media-type etc.
-
+
@return
media type of package
*/
XPackageTypeInfo getPackageType();
-
+
/** exports package to given destination URL.
-
+
@param destFolderURL
package destination folder URL, must be UCB conform
@param newTitle
@@ -312,7 +312,7 @@ interface XPackage
com::sun::star::ucb::CommandAbortedException);
/** returns an icon for a package.
-
+
@param highContrast
return high contrast icon
@return
@@ -343,7 +343,7 @@ interface XPackage
*/
com::sun::star::beans::Optional<string> getRegistrationDataURL()
raises (ExtensionRemovedException);
-
+
/** indicates if this object represents a removed extension or extension
item. This is the case when it was created by providing
<code>true</code> for the <code>removed</code> parameter in the function