1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_logging_XSimpleLogRing_idl__
25#define __com_sun_star_logging_XSimpleLogRing_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31//=============================================================================
32
33module com { module sun { module star { module logging {
34
35//=============================================================================
36
37/** a simple log ring allowing to collect a limited number of last events
38
39    <p>
40    The intention of this interface is to provide a simple possibility
41    for developer to collect the most important events without affecting
42    the performance. For this reasons the messages related API is quite
43    simple, the strings should be produced by the preprocessor mainly.
44    </p>
45
46    @since OpenOffice 3.2
47 */
48interface XSimpleLogRing
49{
50    /** allows to add a message to the logger
51     */
52    void logString( [in] string aMessage );
53
54    /** allows to get the collected messages from the logger
55
56        <p>
57        It is up to logger implementation to provide only the limited
58        number of last messages.
59        </p>
60     */
61    sequence< string > getCollectedLog();
62};
63
64//=============================================================================
65
66}; }; }; };
67
68//=============================================================================
69
70#endif
71