offapi/com/sun/star/logging/XLoggerPool.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: XLoggerPool.idl,v $
  10  * $Revision: 1.3 $
  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 #ifndef __com_sun_star_logging_XLoggerPool_idl__
  32 #define __com_sun_star_logging_XLoggerPool_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module logging {
  41
  42 interface XLogger;
  43
  44 //=============================================================================
  45
  46 /** implements a pool for named <type>XLogger</type> instances
  47
  48     @since OOo 2.3
  49  */
  50 interface XLoggerPool
  51 {
  52     /** retrieves a logger with the given name
  53
  54         <p>Multiple attempts to retrieve a logger with the same name will return
  55         the same instance.</p>
  56
  57         <p>Newly created logger instances are initialized via configuration. See the configuration
  58         module <code>/org.openoffice.Office.Logging</code> for an explanation of the initialization
  59         pattern.</p>
  60     */
  61     XLogger getNamedLogger( [in] string Name );
  62
  63     /** retrieves a logger with the default name &quot;org.openoffice.logging.DefaultLogger&quot;.
  64
  65         <p>Calling this method is equivalent to calling <code>getNamedLogger( &quot;org.openoffice.logging.DefaultLogger&quot; )</code>.</p>
  66     */
  67     XLogger getDefaultLogger();
  68 };
  69
  70 //=============================================================================
  71
  72 }; }; }; };
  73
  74 //=============================================================================
  75
  76 #endif