Objects of this interface reflect a bound package and are issued by a PackageRegistryBackend. More...

import"XPackage.idl";

Inheritance diagram for XPackage:

Exported Interfaces
interface	com::sun::star::lang::XComponent
	implemented to notify that the package has been removed More...

interface	com::sun::star::util::XModifyBroadcaster
	notifies changes of the registration state of the package More...

Public Member Functions
com::sun::star::task::XAbortChannel	createAbortChannel ()
	creates a command channel to be used to asynchronously abort a command. More...

long	checkPrerequisites ([in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv, [in] boolean alreadyInstalled) raises (DeploymentException, ExtensionRemovedException, com::sun::star::ucb::CommandFailedException, com::sun::star::ucb::CommandAbortedException)
	checks if the package can be installed. More...

boolean	checkDependencies ([in] com::sun::star::ucb::XCommandEnvironment xCmdEnv) raises (DeploymentException, ExtensionRemovedException, com::sun::star::ucb::CommandFailedException)
	checks if the dependencies for this package are still satisfied More...

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)
	determines whether the package is currently registered, i.e. More...

void	registerPackage ([in] boolean startup, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv) raises (DeploymentException, ExtensionRemovedException, com::sun::star::ucb::CommandFailedException, com::sun::star::ucb::CommandAbortedException, com::sun::star::lang::IllegalArgumentException)
	registers this XPackage. More...

void	revokePackage ([in] boolean startup, [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)
	revokes this XPackage. More...

boolean	isBundle ()
	reflects whether this package is a bundle of one or more packages, e.g. More...

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)
	Gets packages of the bundle. More...

string	getName ()
	returns the file name of the package. More...

com::sun::star::beans::Optional< string >	getIdentifier ()
	returns the unique extension identifier. More...

string	getVersion () raises (ExtensionRemovedException)
	returns the textual version representation of the package. More...

string	getURL ()
	returns the location of the package. More...

string	getDisplayName () raises (ExtensionRemovedException)
	returns the display name of the package, e.g. More...

string	getDescription () raises (ExtensionRemovedException)
	returns a description string to describe the package. More...

string	getLicenseText () raises (DeploymentException, ExtensionRemovedException)
	returns a string containing the license text. More...

sequence< string >	getUpdateInformationURLs () raises (ExtensionRemovedException)
	returns a sequence of update information URLs. More...

::com::sun::star::beans::StringPair	getPublisherInfo () raises (ExtensionRemovedException)
	returns the publisher info for the package, the strings might be empty, if there is no publisher More...

XPackageTypeInfo	getPackageType ()
	returns the XPackageTypeInfo, e.g. More...

void	exportTo ([in] string destFolderURL, [in] string newTitle, [in] long nameClashAction, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv) raises ( ExtensionRemovedException, com::sun::star::ucb::CommandFailedException, com::sun::star::ucb::CommandAbortedException, com::sun::star::ucb::ContentCreationException)
	exports package to given destination URL. More...

com::sun::star::graphic::XGraphic	getIcon ([in] boolean highContrast) raises (ExtensionRemovedException)
	returns an icon for a package. More...

string	getRepositoryName ()
	returns the name of the repository where this object comes from. More...

com::sun::star::beans::Optional< string >	getRegistrationDataURL () raises (DeploymentException, ExtensionRemovedException)
	return a URL to a directory which contains the registration data. More...

boolean	isRemoved ()
	indicates if this object represents a removed extension or extension item. More...

Public Member Functions inherited from XComponent
void	dispose ()
	The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...

void	addEventListener ([in] XEventListener xListener)
	adds an event listener to the object. More...

void	removeEventListener ([in] XEventListener aListener)
	removes an event listener from the listener list. More...

Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...

void	acquire ()
	increases the reference counter by one. More...

void	release ()
	decreases the reference counter by one. More...

Public Member Functions inherited from XModifyBroadcaster
void	addModifyListener ([in] com::sun::star::util::XModifyListener aListener)
	adds the specified listener to receive events "modified." More...

void	removeModifyListener ([in] com::sun::star::util::XModifyListener aListener)
	removes the specified listener. More...

Detailed Description

Objects of this interface reflect a bound package and are issued by a PackageRegistryBackend.

Since: OOo 2.0

Exported Interfaces

◆ com::sun::star::lang::XComponent

interface com::sun::star::lang::XComponent

implemented to notify that the package has been removed

◆ com::sun::star::util::XModifyBroadcaster

interface com::sun::star::util::XModifyBroadcaster

notifies changes of the registration state of the package

Member Function Documentation

◆ checkDependencies()

boolean checkDependencies	(	[in] com::sun::star::ucb::XCommandEnvironment	xCmdEnv	)
raises	(	DeploymentException,
		ExtensionRemovedException,
		com::sun::star::ucb::CommandFailedException
	)

checks if the dependencies for this package are still satisfied

After updating the OpenOffice.org, some dependencies for packages might no longer be satisfied.

Since: OOo 3.2

Parameters

xCmdEnv command environment for error handling and other interaction.

Returns: TRUE - all dependencies are satisfied FALSE - at least one dependency failed.

◆ checkPrerequisites()

long checkPrerequisites	(	[in] com::sun::star::task::XAbortChannel	xAbortChannel,
		[in] com::sun::star::ucb::XCommandEnvironment	xCmdEnv,
		[in] boolean	alreadyInstalled
	)
raises	(	DeploymentException,
		ExtensionRemovedException,
		com::sun::star::ucb::CommandFailedException,
		com::sun::star::ucb::CommandAbortedException
	)

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 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 hard disk.

Parameters

xAbortChannel	abort channel to asynchronously abort the registration process, or `NULL`
xCmdEnv	command environment for error handling and other interaction.
alreadyInstalled	indicates that an extension with the same identifier is already installed.

Returns: NULL - all prerequisites are met. Otherwise, a value from Prerequisites indicating what prerequisites are missing.

◆ createAbortChannel()

com::sun::star::task::XAbortChannel createAbortChannel ( )

creates a command channel to be used to asynchronously abort a command.

Returns: abort channel

◆ exportTo()

void exportTo	(	[in] string	destFolderURL,
		[in] string	newTitle,
		[in] long	nameClashAction,
		[in] com::sun::star::ucb::XCommandEnvironment	xCmdEnv
	)
raises	(	ExtensionRemovedException,
		com::sun::star::ucb::CommandFailedException,
		com::sun::star::ucb::CommandAbortedException,
		com::sun::star::ucb::ContentCreationException
	)

exports package to given destination URL.

Parameters

destFolderURL	package destination folder URL, must be UCB conforming
newTitle	new package name
nameClashAction	one of com::sun::star::ucb::NameClash
xCmdEnv	command environment for error and progress handling

◆ 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
	)

Gets packages of the bundle.

If isRemoved() returns TRUE then getBundle may return an empty sequence in case the object is not registered.

Parameters

xAbortChannel	abort channel to asynchronously abort the registration process, or `NULL`
xCmdEnv	command environment for error and progress handling

Returns: set of packages enclosed in this package

◆ getDescription()

string getDescription	(		)
raises	(	ExtensionRemovedException
	)

returns a description string to describe the package.

Returns: description

◆ getDisplayName()

string getDisplayName	(		)
raises	(	ExtensionRemovedException
	)

returns the display name of the package, e.g.

for graphical user interfaces (GUI).

Returns: display name of the package

◆ getIcon()

com::sun::star::graphic::XGraphic getIcon	(	[in] boolean	highContrast	)
raises	(	ExtensionRemovedException
	)

returns an icon for a package.

Parameters

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.

◆ getIdentifier()

com::sun::star::beans::Optional<string> getIdentifier ( )

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

◆ getLicenseText()

string getLicenseText	(		)
raises	(	DeploymentException,
		ExtensionRemovedException
	)

returns a string containing the license text.

Returns: license

◆ getName()

string getName ( )

returns the file name of the package.

Returns: file name of the package

◆ getPackageType()

XPackageTypeInfo getPackageType ( )

returns the XPackageTypeInfo, e.g.

media-type etc.

Returns: media type of package

◆ getPublisherInfo()

::com::sun::star::beans::StringPair getPublisherInfo	(		)
raises	(	ExtensionRemovedException
	)

returns the publisher info for the package, the strings might be empty, if there is 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.

◆ getRegistrationDataURL()

com::sun::star::beans::Optional<string> getRegistrationDataURL	(		)
raises	(	DeploymentException,
		ExtensionRemovedException
	)

return a URL to a directory which contains the registration data.

This data may be created when calling XPackage::registerPackage(). If this is the case is indicated by com::sun::star::beans::Optional::IsPresent of the return value. If registration data are created during registration, but the package is currently not registered, for example after calling XPackage::revokePackage(), then com::sun::star::beans::Optional::IsPresent is TRUE and the com::sun::star::beans::Optional::Value may be an empty string.

◆ getRepositoryName()

string getRepositoryName ( )

returns the name of the repository where this object comes from.

◆ getUpdateInformationURLs()

sequence<string> getUpdateInformationURLs	(		)
raises	(	ExtensionRemovedException
	)

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

◆ getURL()

string getURL ( )

returns the location of the package.

Returns: location of package

◆ getVersion()

string getVersion	(		)
raises	(	ExtensionRemovedException
	)

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

◆ isBundle()

boolean 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.

Returns: TRUE if this package is a package bundle, FALSE otherwise

◆ 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
	)

determines whether the package is currently registered, i.e.

whether it is active.

Parameters

xAbortChannel	abort channel to asynchronously abort the registration process, or `NULL`
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.

◆ isRemoved()

boolean isRemoved ( )

indicates if this object represents a removed extension or extension item.

This is the case when it was created by providing TRUE for the removed parameter in the function XPackageRegistry::bindPackage().

◆ registerPackage()

void registerPackage	(	[in] boolean	startup,
		[in] com::sun::star::task::XAbortChannel	xAbortChannel,
		[in] com::sun::star::ucb::XCommandEnvironment	xCmdEnv
	)
raises	(	DeploymentException,
		ExtensionRemovedException,
		com::sun::star::ucb::CommandFailedException,
		com::sun::star::ucb::CommandAbortedException,
		com::sun::star::lang::IllegalArgumentException
	)

registers this XPackage.

NEVER call this directly. This is done by the extension manager if necessary.

Parameters

startup	indicates that registration is adapted to the particular startup scenario. That is, it is set to `TRUE`, when called from XExtensionManager::synchronize()
xAbortChannel	abort channel to asynchronously abort the registration process, or `NULL`
xCmdEnv	command environment for error and progress handling

◆ revokePackage()

void revokePackage	(	[in] boolean	startup,
		[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
	)

revokes this XPackage.

NEVER call this directly. This is done by the extension manager if necessary.

Parameters

startup	indicates that registration is adapted to the particular startup scenario. That is, it is set to `TRUE`, when called from XExtensionManager::synchronize()
xAbortChannel	abort channel to asynchronously abort the registration process, or `NULL`
xCmdEnv	command environment for error and progress handling

The documentation for this interface was generated from the following file:

com/sun/star/deployment/XPackage.idl

Exported Interfaces

Public Member Functions

Detailed Description

Exported Interfaces

◆ com::sun::star::lang::XComponent

◆ com::sun::star::util::XModifyBroadcaster

Member Function Documentation

◆ checkDependencies()

◆ checkPrerequisites()

◆ createAbortChannel()

◆ exportTo()

◆ getBundle()

◆ getDescription()

◆ getDisplayName()

◆ getIcon()

◆ getIdentifier()

◆ getLicenseText()

◆ getName()

◆ getPackageType()

◆ getPublisherInfo()

◆ getRegistrationDataURL()

◆ getRepositoryName()

◆ getUpdateInformationURLs()

◆ getURL()

◆ getVersion()

◆ isBundle()

◆ isRegistered()

◆ isRemoved()

◆ registerPackage()

◆ revokePackage()