offapi/com/sun/star/deployment/XPackageRegistry.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: XPackageRegistry.idl,v $
  10  * $Revision: 1.7 $
  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_XPackageRegistry_idl
  32 #define INCLUDED_com_sun_star_deployment_XPackageRegistry_idl
  33
  34 #include <com/sun/star/deployment/XPackage.idl>
  35 #include <com/sun/star/deployment/XPackageTypeInfo.idl>
  36 #include <com/sun/star/beans/StringPair.idl>
  37
  38
  39 module com { module sun { module star { module deployment {
  40
  41 /** Interface to bind an UNO package.
  42
  43     @since OOo 2.0.0
  44 */
  45 interface XPackageRegistry
  46 {
  47     /** binds a package URL to a <type>XPackage</type> handle.
  48         The returned UNO package handle ought to late-initialize itself,
  49         thus the process of binding must not be an expensive operation, because
  50         it is not abortable.
  51
  52         @param url
  53                package URL, must be UCB conform
  54         @param mediaType
  55                media type of package, empty string if to be detected
  56         @param xCmdEnv
  57                command environment for error and progress handling
  58         @return
  59                <type>XPackage</type> handle
  60     */
  61     XPackage bindPackage(
  62         [in] string url,
  63         [in] string mediaType,
  64         [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
  65         raises (DeploymentException,
  66                 com::sun::star::ucb::CommandFailedException,
  67                 com::sun::star::lang::IllegalArgumentException);
  68
  69     /** gets the supported <type>XPackageTypeInfo</type>s.
  70
  71         @return
  72                 supported <type>XPackageTypeInfo</type>s.
  73     */
  74     sequence<XPackageTypeInfo> getSupportedPackageTypes();
  75 };
  76
  77 }; }; }; };
  78
  79 #endif