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

   1 /*************************************************************************
   2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3  *
   4  * Copyright 2000, 2010 Oracle and/or its affiliates.
   5  *
   6  * OpenOffice.org - a multi-platform office productivity suite
   7  *
   8  * This file is part of OpenOffice.org.
   9  *
  10  * OpenOffice.org is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Lesser General Public License version 3
  12  * only, as published by the Free Software Foundation.
  13  *
  14  * OpenOffice.org is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Lesser General Public License version 3 for more details
  18  * (a copy is included in the LICENSE file that accompanied this code).
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * version 3 along with OpenOffice.org.  If not, see
  22  * <http://www.openoffice.org/license.html>
  23  * for a copy of the LGPLv3 License.
  24  *
  25 ************************************************************************/
  26
  27
  28 #ifndef __com_sun_star_logging_XCsvLogFormatter_idl__
  29 #define __com_sun_star_logging_XCsvLogFormatter_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_logging_XLogFormatter_idl__
  36 #include <com/sun/star/logging/XLogFormatter.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41 module com { module sun { module star { module logging {
  42
  43 //=============================================================================
  44
  45 /** specifies the interface used for formatting log records for RFC4180 csv
  46     output
  47
  48     @see XLogFormatter, XLogHandler
  49
  50     @since OOo 3.0
  51 */
  52 interface XCsvLogFormatter : XLogFormatter
  53 {
  54     /** Defines if the EventNo should be logged */
  55     [attribute] boolean LogEventNo;
  56     /** Defines if the ThreadId should be logged */
  57     [attribute] boolean LogThread;
  58     /** Defines if the Timestamp should be logged */
  59     [attribute] boolean LogTimestamp;
  60     /** Defines if the Source should be logged */
  61     [attribute] boolean LogSource;
  62     /** Defines the names of the additional columns
  63         this defaults to only one row titled "message".
  64         if this is set to more than one column, the
  65         messages need to be preformatted using
  66         <code>formatMultiColumn</code>*/
  67     [attribute] sequence< string >  Columnnames;
  68     /** if the CsvLogFormatter is set to have more than one
  69         column, any logged infomation has to be send through this
  70         method before calling log(). E.g.:
  71
  72         <code>XLoggerInstance.log(1000, XCsvLogFormatterInstance.formatMultiColumn(column_data))</code>
  73     */
  74     string formatMultiColumn( [in] sequence< string > column_data);
  75 };
  76
  77 //=============================================================================
  78
  79 }; }; }; };
  80
  81 //=============================================================================
  82
  83 #endif