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