udkapi/com/sun/star/lang/XServiceInfo.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_XServiceInfo_idl__
  28 #define __com_sun_star_lang_XServiceInfo_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34
  35 //=============================================================================
  36
  37 module com {  module sun {  module star {  module lang {
  38
  39 //=============================================================================
  40
  41 /** Provides information regarding the implementation, i.e. which services
  42     are implemented and the name of the implementation.
  43 */
  44 published interface XServiceInfo: com::sun::star::uno::XInterface
  45 {
  46     /** Provides the implementation name of the service implementation.
  47
  48         @returns
  49                  unique name of the implementation
  50     */
  51     string getImplementationName();
  52
  53     /** Tests whether the specified service is supported, i.e. implemented
  54         by the implementation.
  55
  56         @param ServiceName
  57                name of service to be tested
  58         @return
  59                 true, if service is supported, false otherwise
  60     */
  61     boolean supportsService( [in] string ServiceName );
  62
  63     /** Provides the supported service names of the implementation, including
  64         also indirect service names.
  65
  66         @return
  67                 sequence of service names that are supported
  68     */
  69     sequence<string> getSupportedServiceNames();
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 /*=============================================================================
  77
  78 =============================================================================*/
  79 #endif