offapi/com/sun/star/logging/SimpleLogRing.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: SimpleLogRing.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_SimpleLogRing_idl__
  32 #define __com_sun_star_logging_SimpleLogRing_idl__
  33
  34 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  35 #include <com/sun/star/lang/IllegalArgumentException.idl>
  36 #endif
  37 #ifndef __com_sun_star_beans_NamedValue_idl__
  38 #include <com/sun/star/beans/NamedValue.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module logging {
  44
  45 interface XSimpleLogRing;
  46
  47 //=============================================================================
  48
  49 /** This service allows to log the events in a ring of specified size.
  50
  51     @since OOo 3.2
  52  */
  53 service SimpleLogRing : XSimpleLogRing
  54 {
  55     /** creates a ring of default size - 256 messages
  56      */
  57     create();
  58
  59     /** creates a ring of specified size
  60         @param nSize
  61             the number of messages in a ring
  62      */
  63     createWithSize( [in] long nSize );
  64 };
  65
  66 //=============================================================================
  67
  68 }; }; }; };
  69
  70 //=============================================================================
  71
  72 #endif