summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/logging/XLoggerPool.idl
blob: d98bc554357971865988828d648b291575cac3bd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_logging_XLoggerPool_idl__
#define __com_sun_star_logging_XLoggerPool_idl__

#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl>
#endif

//=============================================================================

module com { module sun { module star { module logging { 

interface XLogger;

//=============================================================================

/** implements a pool for named <type>XLogger</type> instances

    @since OOo 2.3
 */
interface XLoggerPool
{
    /** retrieves a logger with the given name

        <p>Multiple attempts to retrieve a logger with the same name will return
        the same instance.</p>

        <p>Newly created logger instances are initialized via configuration. See the configuration
        module <code>/org.openoffice.Office.Logging</code> for an explanation of the initialization
        pattern.</p>
    */
    XLogger getNamedLogger( [in] string Name );

    /** retrieves a logger with the default name &quot;org.openoffice.logging.DefaultLogger&quot;.

        <p>Calling this method is equivalent to calling <code>getNamedLogger( &quot;org.openoffice.logging.DefaultLogger&quot; )</code>.</p>
    */
    XLogger getDefaultLogger();
};

//=============================================================================

}; }; }; }; 

//=============================================================================

#endif