offapi/com/sun/star/logging/CsvLogFormatter.idl

   1 /*************************************************************************
   2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3 *
   4 * Copyright 2008 by Sun Microsystems, Inc.
   5 *
   6 * OpenOffice.org - a multi-platform office productivity suite
   7 *
   8 * $RCSfile: CsvLogFormatter.idl,v $
   9 *
  10 * $Revision: 1.2 $
  11 *
  12 * This file is part of OpenOffice.org.
  13 *
  14 * OpenOffice.org is free software: you can redistribute it and/or modify
  15 * it under the terms of the GNU Lesser General Public License version 3
  16 * only, as published by the Free Software Foundation.
  17 *
  18 * OpenOffice.org is distributed in the hope that it will be useful,
  19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 * GNU Lesser General Public License version 3 for more details
  22 * (a copy is included in the LICENSE file that accompanied this code).
  23 *
  24 * You should have received a copy of the GNU Lesser General Public License
  25 * version 3 along with OpenOffice.org.  If not, see
  26 * <http://www.openoffice.org/license.html>
  27 * for a copy of the LGPLv3 License.
  28 ************************************************************************/
  29
  30 #ifndef __com_sun_star_logging_CsvLogFormatter_idl__
  31 #define __com_sun_star_logging_CsvLogFormatter_idl__
  32
  33 //=============================================================================
  34
  35 module com { module sun { module star { module logging {
  36
  37 interface XCsvLogFormatter;
  38
  39 //=============================================================================
  40
  41 /** specifies a service which formats log records for RFC4180-style CSV-Files
  42
  43     <p>Every log record, as passed to <member>XCsvLogFormatter::format</member>,
  44     will be formatted into a single row for a CSV file.
  45     The sequence number, the thread ID, the time of the logged event,
  46     the source class/method name will get logged alongside the message, if this
  47     is not disabled. The Formatter also supports logging an arbitrary number of
  48     userdefined columns. If the Formatter is configured to have more than one
  49     (userdefined) column the data to log has to be preformatted with the
  50     formatMultiColumn method.</p>
  51
  52     @since OOo 3.0
  53  */
  54 service CsvLogFormatter : XCsvLogFormatter
  55 {
  56     /// creates a CsvLogFormatter instance
  57     create();
  58 };
  59
  60 //=============================================================================
  61
  62 }; }; }; };
  63
  64 //=============================================================================
  65
  66 #endif