xref: /aoo41x/main/udkapi/com/sun/star/test/XTest.idl (revision 408a4873)
1*408a4873SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*408a4873SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*408a4873SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*408a4873SAndrew Rist * distributed with this work for additional information
6*408a4873SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*408a4873SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*408a4873SAndrew Rist * "License"); you may not use this file except in compliance
9*408a4873SAndrew Rist * with the License.  You may obtain a copy of the License at
10*408a4873SAndrew Rist *
11*408a4873SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*408a4873SAndrew Rist *
13*408a4873SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*408a4873SAndrew Rist * software distributed under the License is distributed on an
15*408a4873SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*408a4873SAndrew Rist * KIND, either express or implied.  See the License for the
17*408a4873SAndrew Rist * specific language governing permissions and limitations
18*408a4873SAndrew Rist * under the License.
19*408a4873SAndrew Rist *
20*408a4873SAndrew Rist *************************************************************/
21*408a4873SAndrew Rist
22*408a4873SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_test_XTest_idl__
24cdf0e10cSrcweir#define __com_sun_star_test_XTest_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
31cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir#ifndef __com_sun_star_test_XTestListener_idl__
35cdf0e10cSrcweir#include <com/sun/star/test/XTestListener.idl>
36cdf0e10cSrcweir#endif
37cdf0e10cSrcweir
38cdf0e10cSrcweir
39cdf0e10cSrcweir//=============================================================================
40cdf0e10cSrcweir
41cdf0e10cSrcweirmodule com { module sun { module star { module test {
42cdf0e10cSrcweir
43cdf0e10cSrcweir//=============================================================================
44cdf0e10cSrcweir/**
45cdf0e10cSrcweir	A simple interface to test a service or interface implementation.
46cdf0e10cSrcweir*/
47cdf0e10cSrcweirpublished interface XTest: com::sun::star::uno::XInterface
48cdf0e10cSrcweir{
49cdf0e10cSrcweir	//-------------------------------------------------------------------------
50cdf0e10cSrcweir	/**
51cdf0e10cSrcweir		Test the object TestObject against the test specified with TestName. This test
52cdf0e10cSrcweir		does not change the semantic state of the object, so it can be called on a existing
53cdf0e10cSrcweir		component that will used further on. Note: This can be a strong test limitation.
54cdf0e10cSrcweir		There are some components, that cannot perform their full test scenario.
55cdf0e10cSrcweir		@param TestName
56cdf0e10cSrcweir			the name of the test. Must be an interface, service, or implementation name.
57cdf0e10cSrcweir			Note: The name is only used by the test component to distinguish between test
58cdf0e10cSrcweir			scenarios.
59cdf0e10cSrcweir		@param TestObject
60cdf0e10cSrcweir				The instance to be tested.
61cdf0e10cSrcweir		@throws IllegalArgumentException
62cdf0e10cSrcweir			if the test does not support TestName or TestObject is null.
63cdf0e10cSrcweir	*/
64cdf0e10cSrcweir	void testInvariant( [in] string TestName,
65cdf0e10cSrcweir			 [in] com::sun::star::uno::XInterface TestObject )
66cdf0e10cSrcweir			raises( com::sun::star::lang::IllegalArgumentException );
67cdf0e10cSrcweir
68cdf0e10cSrcweir	//-------------------------------------------------------------------------
69cdf0e10cSrcweir	/**
70cdf0e10cSrcweir		Test the object TestObject against the test specified with TestName.
71cdf0e10cSrcweir		This test changes the state of the object. The object may be useless
72cdf0e10cSrcweir		afterwards (e.g., a closed XOutputStream). The method in general may
73cdf0e10cSrcweir		be called multiple times with a new test object instance. Note: Each test
74cdf0e10cSrcweir		scenario should be independent of each other, so even if a scenario
75cdf0e10cSrcweir		didn't pass the test, the other test can still be performed.
76cdf0e10cSrcweir		The error messages are cumulative.
77cdf0e10cSrcweir
78cdf0e10cSrcweir		@param TestName
79cdf0e10cSrcweir			The name of the test. Must be an interface, service, or
80cdf0e10cSrcweir			implementation name. Note: The name is only used by the test component
81cdf0e10cSrcweir			to distinguish between test scenarios.
82cdf0e10cSrcweir		@param TestObject
83cdf0e10cSrcweir				The instance to be tested.
84cdf0e10cSrcweir		@param hTestHandle
85cdf0e10cSrcweir				Internal test handle. Handle for first test is always 0.
86cdf0e10cSrcweir			Handle of next test is  returned by the method.
87cdf0e10cSrcweir		@return Handle of the next test. -1 if this was the last test.
88cdf0e10cSrcweir
89cdf0e10cSrcweir		@throws IllegalArgumentException
90cdf0e10cSrcweir			if the test does not support TestName or TestObject is null.
91cdf0e10cSrcweir	*/
92cdf0e10cSrcweir	long test( [in] string TestName,
93cdf0e10cSrcweir			 [in] com::sun::star::uno::XInterface TestObject,
94cdf0e10cSrcweir			 [in] long hTestHandle )
95cdf0e10cSrcweir			raises( com::sun::star::lang::IllegalArgumentException );
96cdf0e10cSrcweir
97cdf0e10cSrcweir	//-------------------------------------------------------------------------
98cdf0e10cSrcweir	/**
99cdf0e10cSrcweir		Test the object TestObject against the test specified with TestName	using
100cdf0e10cSrcweir		several threads. That does NOT mean that testMultiThread should	implement
101cdf0e10cSrcweir		a test using several threads but that this test method should be designed
102cdf0e10cSrcweir		to be called by several threads. So for example, it has to take into consideration
103cdf0e10cSrcweir		that a test object state that is changed by the method	can be
104cdf0e10cSrcweir		changed again by another thread. So it's not necessarily a mistake if an
105cdf0e10cSrcweir		expected state can't be confirmed after setting it. Besides that, everything
106cdf0e10cSrcweir		is the same as described for the test method.
107cdf0e10cSrcweir
108cdf0e10cSrcweir		If this way of testing with multiple threads is not appropriate for the
109cdf0e10cSrcweir		component to be tested this method should not be implemented (it should
110cdf0e10cSrcweir		only return -1) and a special multithread test adapted to the special
111cdf0e10cSrcweir		needs of testing this component should be integrated in the test method.
112cdf0e10cSrcweir
113cdf0e10cSrcweir		@param TestName
114cdf0e10cSrcweir			The name of the test. Must be an interface, service or
115cdf0e10cSrcweir			implementation name. Note: The name is only used by the test component
116cdf0e10cSrcweir			to distinguish between test scenarios.
117cdf0e10cSrcweir		@param TestObject
118cdf0e10cSrcweir			The instance to be tested.
119cdf0e10cSrcweir		@param hTestHandle
120cdf0e10cSrcweir			Internal test handle. Handle for first test is always 0.
121cdf0e10cSrcweir			Handle of next test is  returned by the method.
122cdf0e10cSrcweir		@return Handle of the next test. -1 if this was the last test.
123cdf0e10cSrcweir
124cdf0e10cSrcweir		@throws IllegalArgumentException
125cdf0e10cSrcweir			if the test does not support TestName or TestObject is null.
126cdf0e10cSrcweir	*/
127cdf0e10cSrcweir	long testMultiThread( [in] string TestName,
128cdf0e10cSrcweir			 [in] com::sun::star::uno::XInterface TestObject,
129cdf0e10cSrcweir			 [in] long hTestHandle )
130cdf0e10cSrcweir			raises( com::sun::star::lang::IllegalArgumentException );
131cdf0e10cSrcweir
132cdf0e10cSrcweir	//-------------------------------------------------------------------------
133cdf0e10cSrcweir	/**	registers an event listener, which will be called for reporting
134cdf0e10cSrcweir		errors/exceptions and warnings and for protocol purpuses.
135cdf0e10cSrcweir	*/
136cdf0e10cSrcweir	void addTestListener( [in] XTestListener xListener );
137cdf0e10cSrcweir
138cdf0e10cSrcweir	//-------------------------------------------------------------------------
139cdf0e10cSrcweir	/**	unregisters an event listener which was registered with
140cdf0e10cSrcweir		<member>XTest::addTestListener()</member>.
141cdf0e10cSrcweir
142cdf0e10cSrcweir	*/
143cdf0e10cSrcweir	void removeTestListener( [in] XTestListener xListener );
144cdf0e10cSrcweir
145cdf0e10cSrcweir};
146cdf0e10cSrcweir
147cdf0e10cSrcweir//=============================================================================
148cdf0e10cSrcweir
149cdf0e10cSrcweir}; }; }; };
150cdf0e10cSrcweir
151cdf0e10cSrcweir#endif
152