1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#if ! defined INCLUDED_com_sun_star_deployment_XPackageManagerFactory_idl
25#define INCLUDED_com_sun_star_deployment_XPackageManagerFactory_idl
26
27#include <com/sun/star/lang/IllegalArgumentException.idl>
28#include <com/sun/star/deployment/XPackageManager.idl>
29
30
31module com { module sun { module star { module deployment {
32
33/** The <type>XPackageManagerFactory</type> interface is used to obtain
34    <type>XPackageManager</type> instances.
35    <p>
36    You have to use the singleton
37    <code>
38    /singletons/com.sun.star.deployment.thePackageManagerFactory
39    </code>
40    exclusively.
41    </p>
42
43    @since OpenOffice 2.0
44    @deprecated
45    Use <type>XExtensionManager</type>.
46*/
47interface XPackageManagerFactory
48{
49    /** Method to create (or reusing and already existing)
50        <type>XPackageManager</type> object to add or remove UNO packages
51        persistently.
52        <p>
53        Packages for context strings <code>"user"</code> and
54        <code>"shared"</code> will be registered and
55        revoked persistently.
56        </p>
57        <!-- p>
58        Document contexts (<code>"vnd.sun.star.tdoc:..."</code>) will get a
59        <type>XPackageManager</type> object that stores packages
60        in the given document and modify the manifest.
61        </p -->
62        <p>
63        Context strings other than <code>"user"</code>, <code>"shared"</code>
64        <!-- or <code>vnd.sun.star.tdoc</code --> will last in an
65        <type scope="com::sun::star::lang">IllegalArgumentException</type>.
66        </p>
67
68        @param context
69               context string, e.g.
70               <ul>
71               <li><code>"user"</code>
72                   => persistent storage and registration into installation's
73                      user layer
74               </li>
75               <li><code>"shared"</code>
76                   => persistent storage and registration into installation's
77                      shared layer
78               </li>
79               <!-- li><code>"vnd.sun.star.tdoc:///4711/uno_packages"</code>
80                        (open document)
81                   => transient storage in folder uno_packages
82                      and transient registration
83               </li -->
84               </ul>
85        @return
86               <type>XPackageManager</type> object
87        @throws ::com::sun::star::lang::IllegalArgumentException
88                in case of an invalid context
89    */
90    XPackageManager getPackageManager( [in] string context )
91        raises (com::sun::star::lang::IllegalArgumentException);
92};
93
94}; }; }; };
95
96#endif
97