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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: LogRecord.idl,v $
  10  * $Revision: 1.4 $
  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_LogRecord_idl__
  32 #define __com_sun_star_logging_LogRecord_idl__
  33
  34 #ifndef __com_sun_star_util_DateTime_idl__
  35 #include <com/sun/star/util/DateTime.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module logging {
  41
  42 //=============================================================================
  43
  44 /** assembles the complete information about a to-be-logged event
  45
  46     @see XLogger
  47
  48     @since OOo 2.3
  49  */
  50 struct LogRecord
  51 {
  52     /// specifies the name of the logger at which the record is logged
  53     string  LoggerName;
  54
  55     /** specifies the name of the class, in which the record was logged.
  56
  57         This name might be empty, in case the caller to one of the various
  58         <code>log</code> methods of <type>XLogger</type> did not specify it.
  59     */
  60     string  SourceClassName;
  61
  62     /** specifies the name of the method, in which the record was logged.
  63
  64         This name might be empty, in case the caller to one of the various
  65         <code>log</code> methods of <type>XLogger</type> did not specify it.
  66     */
  67     string  SourceMethodName;
  68
  69     /// specifies the to-be-logged message
  70     string  Message;
  71
  72     /// specifies the time at which the event was logged
  73     ::com::sun::star::util::DateTime
  74             LogTime;
  75
  76     /** specifies the number of the log event.
  77
  78         Subsequent events get assigned increasing sequence numbers by the <type>XLogger</type>
  79         at which they're logged.
  80     */
  81     hyper   SequenceNumber;
  82
  83     /// specifies the ID of the thread in which the event was logged
  84     string  ThreadID;
  85
  86     /** specifies the level of the log event
  87
  88         @see LogLevel
  89     */
  90     long    Level;
  91 };
  92
  93 //=============================================================================
  94
  95 }; }; }; };
  96
  97 //=============================================================================
  98
  99 #endif