offapi/com/sun/star/deployment/XPackageManagerFactory.idl

   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
  21 module com { module sun { module star { module deployment {
  22
  23 /** The XPackageManagerFactory interface is used to obtain
  24     XPackageManager instances.
  25     <p>
  26     You have to use the singleton
  27     <code>
  28     /singletons/com.sun.star.deployment.thePackageManagerFactory
  29     </code>
  30     exclusively.
  31     </p>
  32
  33     @since OOo 2.0
  34     @deprecated
  35     Use XExtensionManager.
  36 */
  37 interface XPackageManagerFactory
  38 {
  39     /** Method to create (or reusing and already existing)
  40         XPackageManager object to add or remove UNO packages
  41         persistently.
  42         <p>
  43         Packages for context strings <code>"user"</code> and
  44         <code>"shared"</code> will be registered and
  45         revoked persistently.
  46         </p>
  47         <!-- p>
  48         Document contexts (<code>"vnd.sun.star.tdoc:..."</code>) will get a
  49         XPackageManager object that stores packages
  50         in the given document and modify the manifest.
  51         </p -->
  52         <p>
  53         Context strings other than <code>"user"</code>, <code>"shared"</code>
  54         <!-- or <code>vnd.sun.star.tdoc</code --> will last in an
  55         com::sun::star::lang::IllegalArgumentException.
  56         </p>
  57
  58         @param context
  59                context string, e.g.
  60                <ul>
  61                <li><code>"user"</code>
  62                    => persistent storage and registration into installation's
  63                       user layer
  64                </li>
  65                <li><code>"shared"</code>
  66                    => persistent storage and registration into installation's
  67                       shared layer
  68                </li>
  69                <!-- li><code>"vnd.sun.star.tdoc:///4711/uno_packages"</code>
  70                         (open document)
  71                    => transient storage in folder uno_packages
  72                       and transient registration
  73                </li -->
  74                </ul>
  75         @return
  76                XPackageManager object
  77         @throws ::com::sun::star::lang::IllegalArgumentException
  78                 in case of an invalid context
  79     */
  80     XPackageManager getPackageManager( [in] string context )
  81         raises (com::sun::star::lang::IllegalArgumentException);
  82 };
  83
  84 }; }; }; };
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */