ooodev.adapter.deployment.package_registry_partial module

class ooodev.adapter.deployment.package_registry_partial.PackageRegistryPartial(component, interface=com.sun.star.deployment.XPackageRegistry)

Bases: object

Partial class for XPackageRegistry.

Parameters:

• component (XPackageRegistry) –

• interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.deployment.XPackageRegistry)

Constructor

Parameters:

• component (XPackageRegistry) – UNO Component that implements com.sun.star.deployment.XPackageRegistry interface.

• interface (UnoInterface, optional) – The interface to be validated. Defaults to XPackageRegistry.

Return type:

None

bind_package(url, media_type, removed, identifier, cmd_env)

binds a package URL to a XPackage handle.

The returned UNO package handle ought to late-initialize itself, thus the process of binding must not be an expensive operation, because it is not abortable.

Calling the function several time with the same parameters must result in returning the same object.

The file or folder at the location where url points to may not exist or it was replaced. This can happen, for example, when a bundled extension was removed by the setup and a user later starts OOo. Then the user data may still contain all registration data of that extension, but the actual extension files do not exist anymore. The registration data must then be cleaned of all the remains of that extension. To do that one creates an XPackage object on behalf of that extension and calls XPackage.revokePackage(). The parameter removed indicates this case. The returned object may not rely on the file or folder to which refers url. Instead it must use previously saved data to successfully carry out the revocation of this object (XPackage.revokePackage()).

The implementation must ensure that there is only one instance of XPackage for the same url at any time. Therefore calling bindPackage() again with the same url but different mediaType (the exception is, if previously an empty string was provided to cause the determination of the media type) or removed parameters will cause an exception. A com.sun.star.lang.IllegalArgumentException will be thrown in case of a different mediaType parameter and a InvalidRemovedParameterException is thrown if the removed parameter is different.

The identifier parameter must be provided when removed = true. If not, then an com.sun.star.lang.IllegalArgumentException will be thrown.

Raises:

• DeploymentException – DeploymentException

• InvalidRemovedParameterException – InvalidRemovedParameterException

• com.sun.star.ucb.CommandFailedException – CommandFailedException

• com.sun.star.lang.IllegalArgumentException – IllegalArgumentException

Return type:

XPackage

Parameters:

• url (str) –

• media_type (str) –

• removed (bool) –

• identifier (str) –

• cmd_env (com.sun.star.ucb.XCommandEnvironment) –

get_supported_package_types()

gets the supported XPackageTypeInfos.

Return type:

Tuple[XPackageTypeInfo, ...]

packageRemoved(url, media_type)

Raises:

• DeploymentException – DeploymentException

• com.sun.star.lang.IllegalArgumentException – IllegalArgumentException

Return type:

None

Parameters:

• url (str) –

• media_type (str) –