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