xref: /trunk/main/offapi/com/sun/star/logging/CsvLogFormatter.idl (revision 96af39f7)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_logging_CsvLogFormatter_idl__
#define __com_sun_star_logging_CsvLogFormatter_idl__

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

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

interface XCsvLogFormatter;

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

/** specifies a service which formats log records for RFC4180-style CSV-Files

    <p>Every log record, as passed to <member>XCsvLogFormatter::format</member>,
	will be formatted into a single row for a CSV file.
	The sequence number, the thread ID, the time of the logged event,
	the source class/method name will get logged alongside the message, if this
	is not disabled. The Formatter also supports logging an arbitrary number of
	userdefined columns. If the Formatter is configured to have more than one
	(userdefined) column the data to log has to be preformatted with the
	formatMultiColumn method.</p>

    @since OpenOffice 3.0
 */
service CsvLogFormatter : XCsvLogFormatter
{
    /// creates a CsvLogFormatter instance
    create();
};

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

}; }; }; };

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

#endif