offapi/com/sun/star/logging/XSimpleLogRing.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: XSimpleLogRing.idl,v $
  10  * $Revision: 1.3 $
  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_XSimpleLogRing_idl__
  32 #define __com_sun_star_logging_XSimpleLogRing_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module logging {
  41
  42 //=============================================================================
  43
  44 /** a simple log ring allowing to collect a limited number of last events
  45
  46     <p>
  47     The intention of this interface is to provide a simple possibility
  48     for developer to collect the most important events without affecting
  49     the performance. For this reasons the messages related API is quite
  50     simple, the strings should be produced by the preprocessor mainly.
  51     </p>
  52
  53     @since OOo 3.2
  54  */
  55 interface XSimpleLogRing
  56 {
  57     /** allows to add a message to the logger
  58      */
  59     void logString( [in] string aMessage );
  60
  61     /** allows to get the collected messages from the logger
  62
  63         <p>
  64         It is up to logger implementation to provide only the limited
  65         number of last messages.
  66         </p>
  67      */
  68     sequence< string > getCollectedLog();
  69 };
  70
  71 //=============================================================================
  72
  73 }; }; }; };
  74
  75 //=============================================================================
  76
  77 #endif