1*b1cdbd2cSJim Jagielski/**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski
25*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_logging_XCsvLogFormatter_idl__
26*b1cdbd2cSJim Jagielski#define __com_sun_star_logging_XCsvLogFormatter_idl__
27*b1cdbd2cSJim Jagielski
28*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__
29*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl>
30*b1cdbd2cSJim Jagielski#endif
31*b1cdbd2cSJim Jagielski
32*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_logging_XLogFormatter_idl__
33*b1cdbd2cSJim Jagielski#include <com/sun/star/logging/XLogFormatter.idl>
34*b1cdbd2cSJim Jagielski#endif
35*b1cdbd2cSJim Jagielski
36*b1cdbd2cSJim Jagielski//=============================================================================
37*b1cdbd2cSJim Jagielski
38*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module logging {
39*b1cdbd2cSJim Jagielski
40*b1cdbd2cSJim Jagielski//=============================================================================
41*b1cdbd2cSJim Jagielski
42*b1cdbd2cSJim Jagielski/** specifies the interface used for formatting log records for RFC4180 csv
43*b1cdbd2cSJim Jagielski	output
44*b1cdbd2cSJim Jagielski
45*b1cdbd2cSJim Jagielski    @see XLogFormatter, XLogHandler
46*b1cdbd2cSJim Jagielski
47*b1cdbd2cSJim Jagielski    @since OpenOffice 3.0
48*b1cdbd2cSJim Jagielski*/
49*b1cdbd2cSJim Jagielskiinterface XCsvLogFormatter : XLogFormatter
50*b1cdbd2cSJim Jagielski{
51*b1cdbd2cSJim Jagielski	/** Defines if the EventNo should be logged */
52*b1cdbd2cSJim Jagielski	[attribute] boolean LogEventNo;
53*b1cdbd2cSJim Jagielski	/** Defines if the ThreadId should be logged */
54*b1cdbd2cSJim Jagielski	[attribute] boolean LogThread;
55*b1cdbd2cSJim Jagielski	/** Defines if the Timestamp should be logged */
56*b1cdbd2cSJim Jagielski	[attribute] boolean LogTimestamp;
57*b1cdbd2cSJim Jagielski	/** Defines if the Source should be logged */
58*b1cdbd2cSJim Jagielski	[attribute] boolean LogSource;
59*b1cdbd2cSJim Jagielski	/** Defines the names of the additional columns
60*b1cdbd2cSJim Jagielski		this defaults to only one row titled "message".
61*b1cdbd2cSJim Jagielski		if this is set to more than one column, the
62*b1cdbd2cSJim Jagielski		messages need to be preformatted using
63*b1cdbd2cSJim Jagielski		<code>formatMultiColumn</code>*/
64*b1cdbd2cSJim Jagielski	[attribute] sequence< string >  Columnnames;
65*b1cdbd2cSJim Jagielski	/** if the CsvLogFormatter is set to have more than one
66*b1cdbd2cSJim Jagielski		column, any logged infomation has to be send through this
67*b1cdbd2cSJim Jagielski		method before calling log(). E.g.:
68*b1cdbd2cSJim Jagielski
69*b1cdbd2cSJim Jagielski		<code>XLoggerInstance.log(1000, XCsvLogFormatterInstance.formatMultiColumn(column_data))</code>
70*b1cdbd2cSJim Jagielski	*/
71*b1cdbd2cSJim Jagielski	string formatMultiColumn( [in] sequence< string > column_data);
72*b1cdbd2cSJim Jagielski};
73*b1cdbd2cSJim Jagielski
74*b1cdbd2cSJim Jagielski//=============================================================================
75*b1cdbd2cSJim Jagielski
76*b1cdbd2cSJim Jagielski}; }; }; };
77*b1cdbd2cSJim Jagielski
78*b1cdbd2cSJim Jagielski//=============================================================================
79*b1cdbd2cSJim Jagielski
80*b1cdbd2cSJim Jagielski#endif
81