1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_logging_ConsoleHandler_idl__
25#define __com_sun_star_logging_ConsoleHandler_idl__
26
27#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
28#include <com/sun/star/lang/IllegalArgumentException.idl>
29#endif
30#ifndef __com_sun_star_beans_NamedValue_idl__
31#include <com/sun/star/beans/NamedValue.idl>
32#endif
33
34//=============================================================================
35
36module com { module sun { module star { module logging {
37
38interface XConsoleHandler;
39
40//=============================================================================
41
42/** specifies a component implementing a log handler whose output
43    channel is the processes console.
44
45    @since OpenOffice 2.3
46 */
47service ConsoleHandler : XConsoleHandler
48{
49    /// creates a <code>ConsoleHandler</code>
50    create();
51
52    /** creates an instance of the log handler, using generic settings
53
54        @param Settings
55            contains the initial settings for the log handler
56
57            <p>The following settings are recognized and supported:
58            <ul><li><code>Encoding</code> - denotes the initial value of the <member>XLogHandler::Encoding</member></li>
59                <li><code>Formatter</code> - denotes the initial value of the <member>XLogHandler::Formatter</member></li>
60                <li><code>Level</code> - denotes the initial value of the <member>XLogHandler::Level</member></li>
61                <li><code>Threshold</code> - denotes the initial value of the <member>XConsoleHandler::Threshold</member></li>
62            </ul></p>
63
64        @throws ::com::sun::star::lang::IllegalArgumentException
65            if <arg>Settings</args> contains arguments with names other than in the list above, or
66            settings whose value is of the wrong type.
67    */
68    createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue > Settings )
69        raises ( ::com::sun::star::lang::IllegalArgumentException );
70};
71
72//=============================================================================
73
74}; }; }; };
75
76//=============================================================================
77
78#endif
79