INTEGRATION: CWS unopkg1 (1.1.2); FILE ADDED

2004/03/24 13:22:06 dbo 1.1.2.5: #115884# documentation
2004/02/26 16:59:28 dbo 1.1.2.4: #i20304# added @since tags
2004/02/24 16:32:04 dbo 1.1.2.3: #i20304# API revision
2004/01/09 14:33:19 dbo 1.1.2.2: #i21218# new API
2003/11/28 12:47:14 dbo 1.1.2.1: #i20304# new

1 files changed, 134 insertions, 0 deletions

diff --git a/offapi/com/sun/star/deployment/XPackageManagerFactory.idl b/offapi/com/sun/star/deployment/XPackageManagerFactory.idl
new file mode 100644
index 000000000000..fca7c2628129
--- /dev/null
+++ b/offapi/com/sun/star/deployment/XPackageManagerFactory.idl
@@ -0,0 +1,134 @@
+/*************************************************************************
+ *
+ *  $RCSfile: XPackageManagerFactory.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: hr $ $Date: 2004-04-13 11:54:44 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library 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 for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#if ! defined INCLUDED_com_sun_star_deployment_XPackageManagerFactory_idl
+#define INCLUDED_com_sun_star_deployment_XPackageManagerFactory_idl
+
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#include <com/sun/star/deployment/PackageManager.idl>
+
+
+module com { module sun { module star { module deployment {
+
+/** Interface to obtain a package manager object.
+
+    @since #i20304#
+ */
+interface XPackageManagerFactory : com::sun::star::uno::XInterface
+{
+    /** Method to create (or reusing and already existing)
+        <type>PackageManager</type> 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 whilst <code>vnd.sun.star.tdoc</code> urls
+        (open documents) will be registered and revoked transiently.
+        </p>
+        <p>
+        Document contexts (<code>"vnd.sun.star.pkg:..."</code>,
+        <code>"vnd.sun.star.tdoc:..."</code>) will get a
+        <type>PackageManager</type> object that stores packages
+        in the given document and modify the manifest.
+        </p>
+        <p>
+        Context strings other than <code>"user"</code>, <code>"shared"</code>,
+        <code>"vnd.sun.star.tdoc:..."</code> and
+        <code>"vnd.sun.star.pkg:..."</code> will last in an
+        <type scope="com::sun::star::lang">IllegalArgumentException</type>.
+        </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>
+               <li><code>"vnd.sun.star.pkg:///x.sxw/uno_packages"</code>
+               (closed document)
+                   => persistent storage in folder uno_packages,
+                      but no registration
+               </li>
+               </ul>
+        @return
+               <type>PackageManager</type> object
+        @throw <type scope="com::sun::star::lang">
+               IllegalArgumentException</type>
+               in case of an invalid context
+    */
+    XPackageManager /* service PackageManager */ getPackageManager(
+        [in] string context )
+        raises (com::sun::star::lang::IllegalArgumentException);
+};
+
+}; }; }; };
+
+#endif