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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XPackageManagerFactory.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #if ! defined INCLUDED_com_sun_star_deployment_XPackageManagerFactory_idl
  32 #define INCLUDED_com_sun_star_deployment_XPackageManagerFactory_idl
  33
  34 #include <com/sun/star/lang/IllegalArgumentException.idl>
  35 #include <com/sun/star/deployment/XPackageManager.idl>
  36
  37
  38 module com { module sun { module star { module deployment {
  39
  40 /** The <type>XPackageManagerFactory</type> interface is used to obtain
  41     <type>XPackageManager</type> instances.
  42     <p>
  43     You have to use the singleton
  44     <code>
  45     /singletons/com.sun.star.deployment.thePackageManagerFactory
  46     </code>
  47     exclusively.
  48     </p>
  49
  50     @since OOo 2.0.0
  51 */
  52 interface XPackageManagerFactory
  53 {
  54     /** Method to create (or reusing and already existing)
  55         <type>XPackageManager</type> object to add or remove UNO packages
  56         persistently.
  57         <p>
  58         Packages for context strings <code>"user"</code> and
  59         <code>"shared"</code> will be registered and
  60         revoked persistently.
  61         </p>
  62         <!-- p>
  63         Document contexts (<code>"vnd.sun.star.tdoc:..."</code>) will get a
  64         <type>XPackageManager</type> object that stores packages
  65         in the given document and modify the manifest.
  66         </p -->
  67         <p>
  68         Context strings other than <code>"user"</code>, <code>"shared"</code>
  69         <!-- or <code>vnd.sun.star.tdoc</code --> will last in an
  70         <type scope="com::sun::star::lang">IllegalArgumentException</type>.
  71         </p>
  72
  73         @param context
  74                context string, e.g.
  75                <ul>
  76                <li><code>"user"</code>
  77                    => persistent storage and registration into installation's
  78                       user layer
  79                </li>
  80                <li><code>"shared"</code>
  81                    => persistent storage and registration into installation's
  82                       shared layer
  83                </li>
  84                <!-- li><code>"vnd.sun.star.tdoc:///4711/uno_packages"</code>
  85                         (open document)
  86                    => transient storage in folder uno_packages
  87                       and transient registration
  88                </li -->
  89                </ul>
  90         @return
  91                <type>XPackageManager</type> object
  92         @throws ::com::sun::star::lang::IllegalArgumentException
  93                 in case of an invalid context
  94     */
  95     XPackageManager getPackageManager( [in] string context )
  96         raises (com::sun::star::lang::IllegalArgumentException);
  97 };
  98
  99 }; }; }; };
 100
 101 #endif