udkapi/com/sun/star/uno/XComponentContext.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: XComponentContext.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 #ifndef __com_sun_star_uno_XComponentContext_idl__
  31 #define __com_sun_star_uno_XComponentContext_idl__
  32
  33 #ifndef __com_sun_star_uno_Exception_idl__
  34 #include <com/sun/star/uno/Exception.idl>
  35 #endif
  36
  37
  38 module com {  module sun {  module star {  module lang {
  39  published interface XMultiComponentFactory;
  40 }; }; }; };
  41
  42 module com {  module sun {  module star {  module uno {
  43
  44 /** Component context to be passed to a component via
  45     <type scope="com::sun::star::lang">XSingleComponentFactory</type>.
  46     Arbitrary values (e.g. deployment values) can be retrieved from the context.
  47 */
  48 published interface XComponentContext : XInterface
  49 {
  50     /** Gets a value from the context.
  51
  52         @param Name
  53                name of value
  54         @return
  55                 value
  56     */
  57     any getValueByName( [in] string Name );
  58
  59     /** Gets the service manager instance to be used from key
  60         <code>/singletons/com.sun.star.lang.theServiceManager</code> (maybe null ref).
  61         This method has been added for convenience, because the
  62         service manager is used very often.
  63
  64         @return
  65                 service manager, if any
  66     */
  67     com::sun::star::lang::XMultiComponentFactory getServiceManager();
  68 };
  69
  70 }; }; }; };
  71
  72 #endif