LibreOffice LibreOffice 25.8 SDK API Reference

XPackage.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21module com { module sun { module star { module deployment {
22
28 interface XPackage
29{
32 interface com::sun::star::lang::XComponent;
33
36 interface com::sun::star::util::XModifyBroadcaster;
37
38
44 com::sun::star::task::XAbortChannel createAbortChannel();
45
66 long checkPrerequisites(
67 [in] com::sun::star::task::XAbortChannel xAbortChannel,
68 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv,
69 [in] boolean alreadyInstalled)
70 raises (DeploymentException,
71 ExtensionRemovedException,
72 com::sun::star::ucb::CommandFailedException,
73 com::sun::star::ucb::CommandAbortedException);
74
89 boolean checkDependencies(
90 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
91 raises (DeploymentException,
92 ExtensionRemovedException,
93 com::sun::star::ucb::CommandFailedException);
94
95
109 com::sun::star::beans::Optional<
110 com::sun::star::beans::Ambiguous<boolean> > isRegistered(
111 [in] com::sun::star::task::XAbortChannel xAbortChannel,
112 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
113 raises (DeploymentException,
114 com::sun::star::ucb::CommandFailedException,
115 com::sun::star::ucb::CommandAbortedException);
116
131 void registerPackage(
132 [in] boolean startup,
133 [in] com::sun::star::task::XAbortChannel xAbortChannel,
134 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
135 raises (DeploymentException,
136 ExtensionRemovedException,
137 com::sun::star::ucb::CommandFailedException,
138 com::sun::star::ucb::CommandAbortedException,
139 com::sun::star::lang::IllegalArgumentException);
140
155 void revokePackage(
156 [in] boolean startup,
157 [in] com::sun::star::task::XAbortChannel xAbortChannel,
158 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
159 raises (DeploymentException,
160 com::sun::star::ucb::CommandFailedException,
161 com::sun::star::ucb::CommandAbortedException,
162 com::sun::star::lang::IllegalArgumentException);
163
170 boolean isBundle();
171
185 sequence<XPackage> getBundle(
186 [in] com::sun::star::task::XAbortChannel xAbortChannel,
187 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
188 raises (DeploymentException,
189 com::sun::star::ucb::CommandFailedException,
190 com::sun::star::ucb::CommandAbortedException,
191 com::sun::star::lang::IllegalArgumentException);
192
198 string getName();
199
208 com::sun::star::beans::Optional<string> getIdentifier();
209
220 string getVersion()
221 raises (ExtensionRemovedException);
222
228 string getURL();
229
236 string getDisplayName()
237 raises (ExtensionRemovedException);
238
244 string getDescription()
245 raises (ExtensionRemovedException);
246
252 string getLicenseText()
253 raises (DeploymentException,
254 ExtensionRemovedException);
255
265 sequence<string> getUpdateInformationURLs()
266 raises (ExtensionRemovedException);
276 ::com::sun::star::beans::StringPair getPublisherInfo()
277 raises (ExtensionRemovedException);
283 XPackageTypeInfo getPackageType();
284
296 void exportTo( [in] string destFolderURL,
297 [in] string newTitle,
298 [in] long nameClashAction,
299 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
300 raises (
301 ExtensionRemovedException,
302 com::sun::star::ucb::CommandFailedException,
303 com::sun::star::ucb::CommandAbortedException,
304 com::sun::star::ucb::ContentCreationException);
305
315 com::sun::star::graphic::XGraphic getIcon( [in] boolean highContrast )
316 raises (ExtensionRemovedException);
317
320 string getRepositoryName();
321
336 com::sun::star::beans::Optional<string> getRegistrationDataURL()
337 raises (DeploymentException, ExtensionRemovedException);
338
344 boolean isRemoved();
345
346};
347
348}; }; }; };
349
350/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::deployment::DeploymentException
A DeploymentException reflects a deployment error.
Definition: DeploymentException.idl:28
com::sun::star::deployment::ExtensionRemovedException
indicates that a function call with the given arguments is not supported because the extension was re...
Definition: ExtensionRemovedException.idl:31
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::ucb::CommandAbortedException
This exception is thrown to indicate that a command was aborted.
Definition: CommandAbortedException.idl:30
com::sun::star::ucb::CommandFailedException
This exception is thrown if an exception situation occurred during the processing of a command and an...
Definition: CommandFailedException.idl:35
com::sun::star::deployment::XPackageTypeInfo
Objects of this interface provide information about a package's type.
Definition: XPackageTypeInfo.idl:27
com::sun::star::deployment::XPackage
Objects of this interface reflect a bound package and are issued by a PackageRegistryBackend.
Definition: XPackage.idl:29
com::sun::star::deployment::XPackage::getIdentifier
com::sun::star::beans::Optional< string > getIdentifier()
returns the unique extension identifier.
com::sun::star::deployment::XPackage::getName
string getName()
returns the file name of the package.
com::sun::star::deployment::XPackage::revokePackage
void revokePackage([in] boolean startup, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
revokes this XPackage.
com::sun::star::deployment::XPackage::isBundle
boolean isBundle()
reflects whether this package is a bundle of one or more packages, e.g.
com::sun::star::deployment::XPackage::checkPrerequisites
long checkPrerequisites([in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv, [in] boolean alreadyInstalled)
checks if the package can be installed.
com::sun::star::deployment::XPackage::checkDependencies
boolean checkDependencies([in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
checks if the dependencies for this package are still satisfied
com::sun::star::deployment::XPackage::registerPackage
void registerPackage([in] boolean startup, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
registers this XPackage.
com::sun::star::deployment::XPackage::getVersion
string getVersion()
returns the textual version representation of the package.
com::sun::star::deployment::XPackage::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)
determines whether the package is currently registered, i.e.
com::sun::star::deployment::XPackage::getBundle
sequence< XPackage > getBundle([in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
Gets packages of the bundle.
com::sun::star::deployment::XPackage::createAbortChannel
com::sun::star::task::XAbortChannel createAbortChannel()
creates a command channel to be used to asynchronously abort a command.
com::sun::star::lang::XComponent
allows to explicitly free resources and break cyclic references.
Definition: XComponent.idl:39
com::sun::star::task::XAbortChannel
Use this interface to abort a command asynchronously.
Definition: XAbortChannel.idl:27
com::sun::star::ucb::XCommandEnvironment
defines the environment for a command.
Definition: XCommandEnvironment.idl:29
com::sun::star::util::XModifyBroadcaster
broadcasts each modification made on the date data of the object which supports this interface.
Definition: XModifyBroadcaster.idl:32
com
Definition: Ambiguous.idl:20