udkapi/com/sun/star/lang/XMultiServiceFactory.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: XMultiServiceFactory.idl,v $
  10  * $Revision: 1.14 $
  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_lang_XMultiServiceFactory_idl__
  31 #define __com_sun_star_lang_XMultiServiceFactory_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_uno_Exception_idl__
  38 #include <com/sun/star/uno/Exception.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module lang {
  45
  46 //=============================================================================
  47
  48 /** Factories support this interface creating instances giving a name,
  49     e.g. a service name.
  50
  51     <p>
  52     Note:
  53     Although this interface deals with the notion of "services", this is not
  54     generally be meant.  In general this interface can be used for all kinds
  55     of factories for all kinds of instances, indeed not only UNO services.
  56     </p>
  57 */
  58 published interface XMultiServiceFactory: com::sun::star::uno::XInterface
  59 {
  60     /** Creates an instance classified by the specified name.
  61
  62         @param aServiceSpecifier
  63                classified name of instance
  64         @return
  65                 instance
  66     */
  67     com::sun::star::uno::XInterface createInstance( [in] string aServiceSpecifier )
  68         raises( com::sun::star::uno::Exception );
  69
  70     /** Creates an instance classified by the specified name and passes the arguments
  71         to that instance.
  72
  73         @param ServiceSpecifier
  74                classified name of instance
  75         @param Arguments
  76                arguments passed to the instance
  77         @return
  78                 instance
  79     */
  80     com::sun::star::uno::XInterface createInstanceWithArguments(
  81         [in] string ServiceSpecifier,
  82         [in] sequence<any> Arguments )
  83         raises( com::sun::star::uno::Exception );
  84
  85     /** Provides the available names of the factory to be used to create instances.
  86
  87         @returns
  88                  sequence of all names
  89     */
  90     sequence<string> getAvailableServiceNames();
  91 };
  92
  93 //=============================================================================
  94
  95 }; }; }; };
  96
  97 /*=============================================================================
  98
  99 =============================================================================*/
 100 #endif