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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_logging_LogRecord_idl__
  29 #define __com_sun_star_logging_LogRecord_idl__
  30
  31 #ifndef __com_sun_star_util_DateTime_idl__
  32 #include <com/sun/star/util/DateTime.idl>
  33 #endif
  34
  35 //=============================================================================
  36
  37 module com { module sun { module star { module logging {
  38
  39 //=============================================================================
  40
  41 /** assembles the complete information about a to-be-logged event
  42
  43     @see XLogger
  44
  45     @since OOo 2.3
  46  */
  47 struct LogRecord
  48 {
  49     /// specifies the name of the logger at which the record is logged
  50     string  LoggerName;
  51
  52     /** specifies the name of the class, in which the record was logged.
  53
  54         This name might be empty, in case the caller to one of the various
  55         <code>log</code> methods of <type>XLogger</type> did not specify it.
  56     */
  57     string  SourceClassName;
  58
  59     /** specifies the name of the method, in which the record was logged.
  60
  61         This name might be empty, in case the caller to one of the various
  62         <code>log</code> methods of <type>XLogger</type> did not specify it.
  63     */
  64     string  SourceMethodName;
  65
  66     /// specifies the to-be-logged message
  67     string  Message;
  68
  69     /// specifies the time at which the event was logged
  70     ::com::sun::star::util::DateTime
  71             LogTime;
  72
  73     /** specifies the number of the log event.
  74
  75         Subsequent events get assigned increasing sequence numbers by the <type>XLogger</type>
  76         at which they're logged.
  77     */
  78     hyper   SequenceNumber;
  79
  80     /// specifies the ID of the thread in which the event was logged
  81     string  ThreadID;
  82
  83     /** specifies the level of the log event
  84
  85         @see LogLevel
  86     */
  87     long    Level;
  88 };
  89
  90 //=============================================================================
  91
  92 }; }; }; };
  93
  94 //=============================================================================
  95
  96 #endif