/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */


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

/** The XPackageManagerFactory interface is used to obtain
    XPackageManager instances.
    <p>
    You have to use the singleton
    <code>
    /singletons/com.sun.star.deployment.thePackageManagerFactory
    </code>
    exclusively.
    </p>

    @since OOo 2.0
    @deprecated
    Use XExtensionManager.
*/
interface XPackageManagerFactory
{
    /** Method to create (or reusing and already existing)
        XPackageManager object to add or remove UNO packages
        persistently.
        <p>
        Packages for context strings <code>"user"</code> and
        <code>"shared"</code> will be registered and
        revoked persistently.
        </p>
        <!-- p>
        Document contexts (<code>"vnd.sun.star.tdoc:..."</code>) will get a
        XPackageManager object that stores packages
        in the given document and modify the manifest.
        </p -->
        <p>
        Context strings other than <code>"user"</code>, <code>"shared"</code>
        <!-- or <code>vnd.sun.star.tdoc</code --> will last in an
        com::sun::star::lang::IllegalArgumentException.
        </p>

        @param context
               context string, e.g.
               <ul>
               <li><code>"user"</code>
                   => persistent storage and registration into installation's
                      user layer
               </li>
               <li><code>"shared"</code>
                   => persistent storage and registration into installation's
                      shared layer
               </li>
               <!-- li><code>"vnd.sun.star.tdoc:///4711/uno_packages"</code>
                        (open document)
                   => transient storage in folder uno_packages
                      and transient registration
               </li -->
               </ul>
        @return
               XPackageManager object
        @throws ::com::sun::star::lang::IllegalArgumentException
                in case of an invalid context
    */
    XPackageManager getPackageManager( [in] string context )
        raises (com::sun::star::lang::IllegalArgumentException);
};

}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */