xref: /AOO41X/main/udkapi/com/sun/star/test/XTestListener.idl (revision 408a4873fc8bcc602c90ea4598886bb71abf0675)
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#ifndef __com_sun_star_test_XTestListener_idl__
24#define __com_sun_star_test_XTestListener_idl__
25
26#ifndef __com_sun_star_lang_XEventListener_idl__
27#include <com/sun/star/lang/XEventListener.idl>
28#endif
29
30#ifndef __com_sun_star_test_TestEvent_idl__
31#include <com/sun/star/test/TestEvent.idl>
32#endif
33
34
35//=============================================================================
36
37module com { module sun { module star { module test {
38
39//=============================================================================
40/** is used to handle errors/exceptions and warnings during tests.
41*/
42published interface XTestListener: com::sun::star::lang::XEventListener
43{
44    //-------------------------------------------------------------------------
45    /** gets called when an error occurs while performing an test.
46        If the error results from an exception, the exception
47        can be found in the Exception member of the TestEvent
48
49        @param evt
50        This property contains the <type>TestEvent</type> object that
51        describes the event source and error description.
52    */
53    void notifyError( [in] com::sun::star::test::TestEvent evt );
54
55    //-------------------------------------------------------------------------
56    /** gets called when an warning occurs while performing an test.
57
58        @param evt
59        This property contains the <type>TestEvent</type> object that
60        describes the event source and warning description.
61    */
62    void notifyWarning( [in] com::sun::star::test::TestEvent evt );
63
64    //-------------------------------------------------------------------------
65    /** can be called by the broadcaster to inform the listener about
66        the progress of the test. The listener can use this information
67        for example to write it into a test protocol file.
68
69        @param evt
70        This property contains the <type>TestEvent</type> object that
71        describes the protocol message.
72    */
73    void protocol( [in] com::sun::star::test::TestEvent evt );
74
75};
76
77//=============================================================================
78
79}; }; }; };
80
81#endif
82