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 file name of the package.
|
getIdentifier |
returns the unique extension identifier.
|
getVersion |
returns the textual version representation of the package.
A textual version representation is a finite string following the
BNF
version ::= [element ("." element)*]
element ::= ("0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9")+
|
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.
|
getUpdateInformationURLs |
returns a sequence of update information URLs.
The sequence may be empty in case no update information is available.
If the sequence contains more than one URL, the extra URLs must mirror
the information available at the first URL.
|
getPublisherInfo |
returns the publisher info for a package, the strings
might be empty, if there are no publisher
::com::sun::star::beans::StringPair::First
represents the publisher name and
::com::sun::star::beans::StringPair::Second
represents the URL to the publisher.
|
getPackageType |
returns the XPackageTypeInfo, e.g. media-type etc.
|
exportTo |
exports package to given destination URL.
|
getIcon |
returns an icon for a package.
|
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.
@installed
signalls if an extension with the same identifyer is already installed.
@aContextName
the name of the context of XPackageManager implementation that is to be used
to install the extension. Currently we use the names "user"
and "shared".
- 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 file name of the package.
- Returns
- file name of the package
|
|
getIdentifier
- Description
- returns the unique extension identifier.
- Returns
- the extension identifier (a
"org.openoffice.legacy." one if the extension does not
explicitly specify one), or an empty Optional if this
package does not represent an extension
|
|
getVersion
- Description
- returns the textual version representation of the package.
A textual version representation is a finite string following the
BNF
version ::= [element ("." element)*]
element ::= ("0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9")+
- Returns
- the textual version representation
|
|
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
|
|
getUpdateInformationURLs
sequence< string > |
getUpdateInformationURLs(); |
- Description
- returns a sequence of update information URLs.
The sequence may be empty in case no update information is available.
If the sequence contains more than one URL, the extra URLs must mirror
the information available at the first URL.
- Returns
- update information URLs
|
|
getPublisherInfo
- Description
- returns the publisher info for a package, the strings
might be empty, if there are no publisher
::com::sun::star::beans::StringPair::First
represents the publisher name and
::com::sun::star::beans::StringPair::Second
represents the URL to the publisher.
|
|
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
|
|
getIcon
- Description
- returns an icon for a package.
- Parameter highContrast
- return high contrast icon
- Returns
- the icon which should be used to represent the table in the
database application window, or NULL if the default icon
should be used.
|
|
Copyright © 2010 Sun Microsystems, Inc.