:: com :: sun :: star :: deployment ::

unpublished interface XPackage
Base Interfaces
XPackage
┣ ::com::sun::star::lang::XComponent
┗ ::com::sun::star::util::XModifyBroadcaster

::com::sun::star::lang::XComponent
Description
implemented to notify that the package has been removed
::com::sun::star::util::XModifyBroadcaster
Description
notifies changes of the registration state of the package
Description
Objects of this interface reflect a bound package and are issued by a PackageRegistryBackend .
Since
OpenOffice 2.0.0

Methods' Summary
createAbortChannel creates a command channel to be used to asynchronously abort a command.  
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
::com::sun::star::task::XAbortChannel
createAbortChannel();

Description
creates a command channel to be used to asynchronously abort a command.
Returns
abort channel
isRegistered
::com::sun::star::beans::Optional< ::com::sun::star::beans::Ambiguous< boolean > >
isRegistered( [in] ::com::sun::star::task::XAbortChannel  xAbortChannel,
[in] ::com::sun::star::ucb::XCommandEnvironment  xCmdEnv )
raises( DeploymentException,
::com::sun::star::ucb::CommandFailedException,
::com::sun::star::ucb::CommandAbortedException );

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
void
registerPackage( [in] ::com::sun::star::task::XAbortChannel  xAbortChannel,
[in] ::com::sun::star::ucb::XCommandEnvironment  xCmdEnv )
raises( DeploymentException,
::com::sun::star::ucb::CommandFailedException,
::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::lang::IllegalArgumentException );

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
void
revokePackage( [in] ::com::sun::star::task::XAbortChannel  xAbortChannel,
[in] ::com::sun::star::ucb::XCommandEnvironment  xCmdEnv )
raises( DeploymentException,
::com::sun::star::ucb::CommandFailedException,
::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::lang::IllegalArgumentException );

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
boolean
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
sequence< XPackage >
getBundle( [in] ::com::sun::star::task::XAbortChannel  xAbortChannel,
[in] ::com::sun::star::ucb::XCommandEnvironment  xCmdEnv )
raises( DeploymentException,
::com::sun::star::ucb::CommandFailedException,
::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::lang::IllegalArgumentException );

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
string
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
string
getURL();

Description
returns the location of the package.
Returns
location of package
getDisplayName
string
getDisplayName();

Description
returns the display name of the package, e.g. for graphical user interfaces (GUI).
Returns
display name of the package
getDescription
string
getDescription();

Description
returns a description string to describe the package.
Returns
description
getPackageType
XPackageTypeInfo
getPackageType();

Description
returns the XPackageTypeInfo , e.g. media-type etc.
Returns
media type of package
exportTo
void
exportTo( [in] string  destFolderURL,
[in] string  newTitle,
[in] long  nameClashAction,
[in] ::com::sun::star::ucb::XCommandEnvironment  xCmdEnv )
raises( ::com::sun::star::ucb::CommandFailedException,
::com::sun::star::ucb::CommandAbortedException );

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
Top of Page