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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_logging_LogRecord_idl__
  21 #define __com_sun_star_logging_LogRecord_idl__
  22
  23 #include <com/sun/star/util/DateTime.idl>
  24
  25
  26 module com { module sun { module star { module logging {
  27
  28
  29 /** assembles the complete information about a to-be-logged event
  30
  31     @see XLogger
  32
  33     @since OOo 2.3
  34  */
  35 struct LogRecord
  36 {
  37     /// specifies the name of the logger at which the record is logged
  38     string  LoggerName;
  39
  40     /** specifies the name of the class, in which the record was logged.
  41
  42         This name might be empty, in case the caller to one of the various
  43         <code>log</code> methods of XLogger did not specify it.
  44     */
  45     string  SourceClassName;
  46
  47     /** specifies the name of the method, in which the record was logged.
  48
  49         This name might be empty, in case the caller to one of the various
  50         <code>log</code> methods of XLogger did not specify it.
  51     */
  52     string  SourceMethodName;
  53
  54     /// specifies the to-be-logged message
  55     string  Message;
  56
  57     /// specifies the time at which the event was logged
  58     ::com::sun::star::util::DateTime
  59             LogTime;
  60
  61     /** specifies the number of the log event.
  62
  63         Subsequent events get assigned increasing sequence numbers by the XLogger
  64         at which they're logged.
  65     */
  66     hyper   SequenceNumber;
  67
  68     /// specifies the ID of the thread in which the event was logged
  69     string  ThreadID;
  70
  71     /** specifies the level of the log event
  72
  73         @see LogLevel
  74     */
  75     long    Level;
  76 };
  77
  78
  79 }; }; }; };
  80
  81
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */