/************************************************************************* * * $RCSfile: XTest.idl,v $ * * $Revision: 1.2 $ * * last change: $Author: mi $ $Date: 2000-11-06 13:01:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses * * - GNU Lesser General Public License Version 2.1 * - Sun Industry Standards Source License Version 1.1 * * Sun Microsystems Inc., October, 2000 * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2000 by Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, CA 94303, USA * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License version 2.1, as published by the Free Software Foundation. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307 USA * * * Sun Industry Standards Source License Version 1.1 * ================================================= * The contents of this file are subject to the Sun Industry Standards * Source License Version 1.1 (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.openoffice.org/license.html. * * Software provided under this License is provided on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. * See the License for the specific provisions governing your rights and * obligations concerning the Software. * * The Initial Developer of the Original Code is: Sun Microsystems, Inc. * * Copyright: 2000 by Sun Microsystems, Inc. * * All Rights Reserved. * * Contributor(s): _______________________________________ * * ************************************************************************/ #ifndef __com_sun_star_test_XTest_idl__ #define __com_sun_star_test_XTest_idl__ #ifndef __com_sun_star_uno_XInterface_idl__ #include #endif #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ #include #endif #ifndef __com_sun_star_test_XTestListener_idl__ #include #endif //============================================================================= module com { module sun { module star { module test { //============================================================================= /** A simple interface to test a service or interface implementation. */ [ uik(DEB08308-3235-11d4-9F730050-04D8BBC7), ident( "XTest", 1.0 ) ] interface XTest: 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. @exception 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 : 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. @exception 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 ); //------------------------------------------------------------------------- /** Test the object TestObject against the test specified with TestName using several threads. That does NOT mean that testMultiThread should implement a test using several threads but that this test method should be designed to be called by several threads. So for example it has to take into consi- deration that a test object state that is changed by the method can be changed again by another thread. So it's not necessarely a mistake if an expected state can't be confirmed after setting it. Besides of that every- thing is the same as decribed for the test method. If this way of testing with multiple threads is not appropriate for the component to be tested this method should not be implemented (it should only return -1) and a special multithread test adapted to the special needs of testing this component should be integrated in the test method. @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. @exception IllegalArgumentException if the test does not support TestName or TestObject is null. */ long testMultiThread( [in] string TestName, [in] com::sun::star::uno::XInterface TestObject, [in] long hTestHandle ) raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- /** registers an event listener, which will be called for reporting errors/exceptions and warnings and for protocol purpuses. */ void addTestListener( [in] XTestListener xListener ); //------------------------------------------------------------------------- /** unregisters an event listener which was registered with XTest::addTestListener(). */ void removeTestListener( [in] XTestListener xListener ); }; //============================================================================= }; }; }; }; #endif