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
28#ifndef __com_sun_star_logging_ConsoleHandler_idl__
29#define __com_sun_star_logging_ConsoleHandler_idl__
30
31#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
32#include <com/sun/star/lang/IllegalArgumentException.idl>
33#endif
34#ifndef __com_sun_star_beans_NamedValue_idl__
35#include <com/sun/star/beans/NamedValue.idl>
36#endif
37
38//=============================================================================
39
40module com { module sun { module star { module logging {
41
42interface XConsoleHandler;
43
44//=============================================================================
45
46/** specifies a component implementing a log handler whose output
47    channel is the processes console.
48
49    @since OOo 2.3
50 */
51service ConsoleHandler : XConsoleHandler
52{
53    /// creates a <code>ConsoleHandler</code>
54    create();
55
56    /** creates an instance of the log handler, using generic settings
57
58        @param Settings
59            contains the initial settings for the log handler
60
61            <p>The following settings are recognized and supported:
62            <ul><li><code>Encoding</code> - denotes the initial value of the <member>XLogHandler::Encoding</member></li>
63                <li><code>Formatter</code> - denotes the initial value of the <member>XLogHandler::Formatter</member></li>
64                <li><code>Level</code> - denotes the initial value of the <member>XLogHandler::Level</member></li>
65                <li><code>Threshold</code> - denotes the initial value of the <member>XConsoleHandler::Threshold</member></li>
66            </ul></p>
67
68        @throws ::com::sun::star::lang::IllegalArgumentException
69            if <arg>Settings</args> contains arguments with names other than in the list above, or
70            settings whose value is of the wrong type.
71    */
72    createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue > Settings )
73        raises ( ::com::sun::star::lang::IllegalArgumentException );
74};
75
76//=============================================================================
77
78}; }; }; };
79
80//=============================================================================
81
82#endif
83