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
25#ifndef __com_sun_star_logging_XCsvLogFormatter_idl__
26#define __com_sun_star_logging_XCsvLogFormatter_idl__
27
28#ifndef __com_sun_star_uno_XInterface_idl__
29#include <com/sun/star/uno/XInterface.idl>
30#endif
31
32#ifndef __com_sun_star_logging_XLogFormatter_idl__
33#include <com/sun/star/logging/XLogFormatter.idl>
34#endif
35
36//=============================================================================
37
38module com { module sun { module star { module logging {
39
40//=============================================================================
41
42/** specifies the interface used for formatting log records for RFC4180 csv
43	output
44
45    @see XLogFormatter, XLogHandler
46
47    @since OpenOffice 3.0
48*/
49interface XCsvLogFormatter : XLogFormatter
50{
51	/** Defines if the EventNo should be logged */
52	[attribute] boolean LogEventNo;
53	/** Defines if the ThreadId should be logged */
54	[attribute] boolean LogThread;
55	/** Defines if the Timestamp should be logged */
56	[attribute] boolean LogTimestamp;
57	/** Defines if the Source should be logged */
58	[attribute] boolean LogSource;
59	/** Defines the names of the additional columns
60		this defaults to only one row titled "message".
61		if this is set to more than one column, the
62		messages need to be preformatted using
63		<code>formatMultiColumn</code>*/
64	[attribute] sequence< string >  Columnnames;
65	/** if the CsvLogFormatter is set to have more than one
66		column, any logged information has to be send through this
67		method before calling log(). E.g.:
68
69		<code>XLoggerInstance.log(1000, XCsvLogFormatterInstance.formatMultiColumn(column_data))</code>
70	*/
71	string formatMultiColumn( [in] sequence< string > column_data);
72};
73
74//=============================================================================
75
76}; }; }; };
77
78//=============================================================================
79
80#endif
81