udkapi/com/sun/star/lang/XMultiComponentFactory.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_lang_XMultiComponentFactory_idl__
  28 #define __com_sun_star_lang_XMultiComponentFactory_idl__
  29
  30 #ifndef __com_sun_star_uno_XComponentContext_idl__
  31 #include <com/sun/star/uno/XComponentContext.idl>
  32 #endif
  33
  34
  35 //=============================================================================
  36
  37 module com {  module sun {  module star {  module lang {
  38
  39 /** Factory interface for creating component instances giving a context from
  40     which to retrieve deployment values.
  41
  42     @see XInitialization
  43 */
  44 published interface XMultiComponentFactory : com::sun::star::uno::XInterface
  45 {
  46     /** Creates an instance of a component which supports the
  47         services specified by the factory.
  48
  49         @param aServiceSpecifier
  50                service name
  51         @param Context
  52                context the component instance gets its deployment values from
  53         @return
  54                 component instance
  55     */
  56     com::sun::star::uno::XInterface createInstanceWithContext(
  57         [in] string aServiceSpecifier,
  58         [in] com::sun::star::uno::XComponentContext Context )
  59         raises (com::sun::star::uno::Exception);
  60
  61     /** Creates an instance of a component which supports the
  62         services specified by the factory, and initializes the new instance
  63         with the given arguments and context.
  64
  65         @param ServiceSpecifier
  66                service name
  67         @param Arguments
  68                arguments
  69         @param Context
  70                context the component instance gets its deployment values from
  71         @return
  72                 component instance
  73     */
  74     com::sun::star::uno::XInterface createInstanceWithArgumentsAndContext(
  75         [in] string ServiceSpecifier,
  76         [in] sequence<any> Arguments,
  77         [in] com::sun::star::uno::XComponentContext Context )
  78         raises (com::sun::star::uno::Exception);
  79
  80     /** Gets the names of all supported services.
  81
  82         @returns
  83                  sequence of all service names
  84     */
  85     sequence< string > getAvailableServiceNames();
  86 };
  87
  88 }; }; }; };
  89
  90 #endif