summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/deployment/XPackage.idl
blob: e613c6f80edcbf09b285a69acccd66d3ac9c1f2a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#if ! defined INCLUDED_com_sun_star_deployment_XPackage_idl
#define INCLUDED_com_sun_star_deployment_XPackage_idl

#include <com/sun/star/beans/Optional.idl>
#include <com/sun/star/beans/Ambiguous.idl>
#include <com/sun/star/beans/StringPair.idl>
#include <com/sun/star/deployment/DeploymentException.idl>
#include <com/sun/star/deployment/XPackageTypeInfo.idl>
#include <com/sun/star/graphic/XGraphic.idl>
#include <com/sun/star/lang/XComponent.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/task/XAbortChannel.idl>
#include <com/sun/star/ucb/CommandFailedException.idl>
#include <com/sun/star/ucb/CommandAbortedException.idl>
#include <com/sun/star/ucb/XCommandEnvironment.idl>
#include <com/sun/star/util/XModifyBroadcaster.idl>


module com { module sun { module star { module deployment {

/** Objects of this interface reflect a bound package and are issued by a
    <type>PackageRegistryBackend</type>.
    
    @since OOo 2.0.0
*/
interface XPackage
{
    /** implemented to notify that the package has been removed
     */
    interface com::sun::star::lang::XComponent;
    
    /** notifies changes of the registration state of the package
     */
    interface com::sun::star::util::XModifyBroadcaster;
    

    /** creates a command channel to be used to asynchronously abort a command.
        
        @return
                abort channel
    */
    com::sun::star::task::XAbortChannel createAbortChannel();
    
    /** 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.
        
        @param 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".

        @return
            true - the package can be installed
            false - the package must not be installed.
     */
    boolean checkPrerequisites(
        [in] com::sun::star::task::XAbortChannel xAbortChannel,
        [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv,
        [in] boolean installed,
        [in] string aContextName)
        raises (DeploymentException,
                com::sun::star::ucb::CommandFailedException,
                com::sun::star::ucb::CommandAbortedException);
  
    /** checks if the dependencies for this package are still satisfied

        After updateing the OpenOffice.org, some dependencies for packages might
        no longer be satisfied.
        
        @since OOo 3.2.0

        @param xCmdEnv
               command environment for error handling and other interaction.

        @return
            true - all dependencies are satisfied
            false - at least one dependency failed.
     */
    boolean checkDependencies(
        [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
        raises (DeploymentException,
                com::sun::star::ucb::CommandFailedException);
  

    /** determines whether the package is currently is registered, i.e.
        whether it is active.
        
        @param xAbortChannel
               abort channel to asynchronously abort the registration process,
               or null
        @param xCmdEnv
               command environment for error and progress handling
        @return
                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.
    */
    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);
    
    /** registers this <type>XPackage</type>, thus activating the package.

        @param xAbortChannel
               abort channel to asynchronously abort the registration process,
               or null
        @param xCmdEnv
               command environment for error and progress handling
    */
    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);
    
    /** revokes this <type>XPackage</type>.
        
        @param xAbortChannel
               abort channel to asynchronously abort the registration process,
               or null
        @param xCmdEnv
               command environment for error and progress handling
    */
    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);
    
    /** 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.
        
        @return
                in case this package relfects a package bundle
    */
    boolean isBundle();
    
    /** Gets packages of the bundle.

        @param xAbortChannel
               abort channel to asynchronously abort the registration process,
               or null
        @param xCmdEnv
               command environment for error and progress handling
        @return
                set of packages enclosed in this package
    */
    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);
    
    /** returns the file name of the package.

        @return
                file name of the package
    */
    string getName();

    /** returns the unique extension identifier.

        @return
                the extension identifier (a
        <code>"org.openoffice.legacy."</code> one if the extension does not
        explicitly specify one), or an empty <code>Optional</code> if this
        package does not represent an extension
    */
    com::sun::star::beans::Optional<string> getIdentifier();

    /** returns the textual version representation of the package.

        A textual version representation is a finite string following the
        BNF<br/>
        version ::= [element ("." element)*]<br/>
        element ::= ("0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9")+

        @return
                the textual version representation
    */
    string getVersion();
    
    /** returns the location of the package.
        
        @return
                location of package
    */
    string getURL();
    
    /** returns the display name of the package, e.g. for graphical user
        interfaces (GUI).
        
        @return
                display name of the package
    */
    string getDisplayName();
    
    /** returns a description string to describe the  package.
        
        @return
                description
    */
    string getDescription();

    /** 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.

        @return
                update information URLs
    */
    sequence<string> getUpdateInformationURLs();
    
    /** returns the publisher info for a package, the strings
        might be empty, if there are no publisher

        <type scope="::com::sun::star::beans">StringPair</type>::First
        represents the publisher name and
        <type scope="::com::sun::star::beans">StringPair</type>::Second
        represents the URL to the publisher.
    */

    ::com::sun::star::beans::StringPair getPublisherInfo();

    /** returns the <type>XPackageTypeInfo</type>, e.g. media-type etc.
        
        @return
                media type of package
    */
    XPackageTypeInfo getPackageType();
    
    /** exports package to given destination URL.
        
        @param destFolderURL
               package destination folder URL, must be UCB conform
        @param newTitle
               new package name
        @param nameClashAction
               one of <type scope="com::sun::star::ucb">NameClash</type>
        @param xCmdEnv
               command environment for error and progress handling
    */
    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);

    /** returns an icon for a package.
        
        @param highContrast
            return high contrast icon
        @return
            the icon which should be used to represent the table in the
            database application window, or <NULL/> if the default icon
            should be used.
    */
    com::sun::star::graphic::XGraphic getIcon( [in] boolean highContrast );
};

}; }; }; };

#endif