Methods' Summary |
createAbortChannel |
creates a command channel to be used to asynchronously abort a command.
|
checkPrerequisites |
checks if the package can be installed.
Only if the return value is true the package is allowed to be installed.
In case of false or in case of an exception, the package must be removed
in 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.
|
isRegistered |
determines whether the package is currently is registered, i.e.
whether it is active.
|
registerPackage |
registers this XPackage , thus activating the package.
|
revokePackage |
revokes this XPackage .
|
isBundle |
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.
|
getBundle |
Gets packages of the bundle.
|
getName |
returns the name of the package, i.e. the unique name of the package
correspondiung to its deployment context (user, shared, ...).
|
getURL |
returns the location of the package.
|
getDisplayName |
returns the display name of the package, e.g. for graphical user
interfaces (GUI).
|
getDescription |
returns a description string to describe the package.
|
getPackageType |
returns the XPackageTypeInfo , e.g. media-type etc.
|
exportTo |
exports package to given destination URL.
|
Methods' Details |
createAbortChannel
- Description
- creates a command channel to be used to asynchronously abort a command.
- Returns
-
abort channel
|
|
checkPrerequisites
- Description
- checks if the package can be installed.
Only if the return value is true the package is allowed to be installed.
In case of false or in case of an exception, the package must be removed
in 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.
- Parameter xCmdEnv
-
command environment for error handling and other interaction.
- Returns
-
true - the package can be installed
false - the package must not be installed.
|
|
isRegistered
- Description
- determines whether the package is currently is registered, i.e.
whether it is active.
- Parameter xAbortChannel
-
abort channel to asynchronously abort the registration process,
or null
- Parameter xCmdEnv
-
command environment for error and progress handling
- Returns
-
status whether the package is registered ( true , false ) or
the status is ambiguous. Additionally, a registration status
may not apply, e.g. in case of an empty package bundle.
|
|
registerPackage
- Description
- registers this XPackage , thus activating the package.
- Parameter xAbortChannel
-
abort channel to asynchronously abort the registration process,
or null
- Parameter xCmdEnv
-
command environment for error and progress handling
|
|
revokePackage
- Description
- revokes this XPackage .
- Parameter xAbortChannel
-
abort channel to asynchronously abort the registration process,
or null
- Parameter xCmdEnv
-
command environment for error and progress handling
|
|
isBundle
- Description
- 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.
- Returns
-
in case this package relfects a package bundle
|
|
getBundle
- Description
- Gets packages of the bundle.
- Parameter xAbortChannel
-
abort channel to asynchronously abort the registration process,
or null
- Parameter xCmdEnv
-
command environment for error and progress handling
- Returns
-
set of packages enclosed in this package
|
|
getName
- Description
- returns the name of the package, i.e. the unique name of the package
correspondiung to its deployment context (user, shared, ...).
- Returns
-
name of the package
|
|
getURL
- Description
- returns the location of the package.
- Returns
-
location of package
|
|
getDisplayName
- Description
- returns the display name of the package, e.g. for graphical user
interfaces (GUI).
- Returns
-
display name of the package
|
|
getDescription
- Description
- returns a description string to describe the package.
- Returns
-
description
|
|
getPackageType
- Description
- returns the XPackageTypeInfo , e.g. media-type etc.
- Returns
-
media type of package
|
|
exportTo
- Description
- exports package to given destination URL.
- Parameter destFolderURL
-
package destination folder URL, must be UCB conform
- Parameter newTitle
-
new package name
- Parameter nameClashAction
-
one of ::com::sun::star::ucb::NameClash
- Parameter xCmdEnv
-
command environment for error and progress handling
|
|
Copyright © 2003 Sun Microsystems, Inc.