summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/test/XSimpleTest.idl
blob: 1d4bb325621bd479091206beb25bb218cff66ca6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_test_XSimpleTest_idl__
#define __com_sun_star_test_XSimpleTest_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>


//=============================================================================

module com { module sun { module star { module test {

//=============================================================================
/**
    A simple interface to test a service or interface implementation.
*/
published interface XSimpleTest: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /**
        Test the object TestObject against the test specified with TestName. This test
        does not change the semantic state of the object, so it can be called on a existing
        component that will used further on.
        Note : This can be a strong test limitation. There are some components, that cannot
        perform their full test scenario.
        @param TestName     the name of the test. Must be an interface, service or implementation name.
        Note : The name is only used by the test component to distinguish
        between test scenarios.
        @param  TestObject  The instance to be tested.

        @throws IllegalArgumentException
            if the test does not support TestName or TestObject is null.
    */
    void testInvariant( [in] string TestName,
             [in] com::sun::star::uno::XInterface TestObject )
            raises( com::sun::star::lang::IllegalArgumentException );

    //-------------------------------------------------------------------------
    /**
        Test the object TestObject against the test specified with TestName. This test
        changes the state of the object. The object may be useless afterwards.
        (e.g. a closed XOutputStream). The method in general may be called multipe times with a new
        test object instance.
        Note : These tests should include the testInvariant test.
        Note : Each test scenario should be independent of each other, so even if a scenario
        didn't pass the test, the other test can still be performed. The error messages
        are cumulative.

        @param TestName     The name of the test. Must be an interface, service or implementation name.
        Note : The name is only used by the test component to distinguish
        between test scenarios.
        @param  TestObject  The instance to be tested.
        @param   hTestHandle Internal test handle. Handle for first test is always 0.
        Handle of next test is  returned by the method.
        @return  Handle of the next test. -1 if this was the last test.

        @throws IllegalArgumentException
            if the test does not support TestName or
        TestObject is null.
    */
    long test( [in] string TestName,
             [in] com::sun::star::uno::XInterface TestObject,
             [in] long hTestHandle )
            raises( com::sun::star::lang::IllegalArgumentException );

    //-------------------------------------------------------------------------
    /**States if one of the last test has failed. This is cumulative.
        @return true if all test have been passed successfully. false if an error has occurred.

    */
    boolean testPassed();

    //-------------------------------------------------------------------------
    // DOCUMENTATION MISSING FOR XSimpleTest::getErrors
    sequence<string> getErrors();

    //-------------------------------------------------------------------------
    // DOCUMENTATION MISSING FOR XSimpleTest::getErrorExceptions
    sequence<any> getErrorExceptions();

    //-------------------------------------------------------------------------
    // DOCUMENTATION MISSING FOR XSimpleTest::getWarnings
    sequence<string> getWarnings();

};

//=============================================================================

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */