1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_test_XSimpleTest_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_test_XSimpleTest_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 35*cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 36*cdf0e10cSrcweir#endif 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir//============================================================================= 40*cdf0e10cSrcweir 41*cdf0e10cSrcweirmodule com { module sun { module star { module test { 42*cdf0e10cSrcweir 43*cdf0e10cSrcweir//============================================================================= 44*cdf0e10cSrcweir/** 45*cdf0e10cSrcweir A simple interface to test a service or interface implementation. 46*cdf0e10cSrcweir*/ 47*cdf0e10cSrcweirpublished interface XSimpleTest: com::sun::star::uno::XInterface 48*cdf0e10cSrcweir{ 49*cdf0e10cSrcweir //------------------------------------------------------------------------- 50*cdf0e10cSrcweir /** 51*cdf0e10cSrcweir Test the object TestObject against the test specified with TestName. This test 52*cdf0e10cSrcweir does not change the semantic state of the object, so it can be called on a existing 53*cdf0e10cSrcweir component that will used further on. 54*cdf0e10cSrcweir Note : This can be a strong test limitation. There are some components, that cannot 55*cdf0e10cSrcweir perform their full test scenario. 56*cdf0e10cSrcweir @param TestName the name of the test. Must be an interface, service or implementation name. 57*cdf0e10cSrcweir Note : The name is only used by the test component to distinguish 58*cdf0e10cSrcweir between test scenarios. 59*cdf0e10cSrcweir @param TestObject The instance to be tested. 60*cdf0e10cSrcweir 61*cdf0e10cSrcweir @throws IllegalArgumentException 62*cdf0e10cSrcweir if the test does not support TestName or TestObject is null. 63*cdf0e10cSrcweir */ 64*cdf0e10cSrcweir void testInvariant( [in] string TestName, 65*cdf0e10cSrcweir [in] com::sun::star::uno::XInterface TestObject ) 66*cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException ); 67*cdf0e10cSrcweir 68*cdf0e10cSrcweir //------------------------------------------------------------------------- 69*cdf0e10cSrcweir /** 70*cdf0e10cSrcweir Test the object TestObject against the test specified with TestName. This test 71*cdf0e10cSrcweir changes the state of the object. The object may be useless afterwards. 72*cdf0e10cSrcweir (e.g. a closed XOutputStream). The method in general may be called multipe times with a new 73*cdf0e10cSrcweir test object instance. 74*cdf0e10cSrcweir Note : These tests should include the testInvariant test. 75*cdf0e10cSrcweir Note : Each test scenario should be independent of each other, so even if a scenario 76*cdf0e10cSrcweir didn't pass the test, the other test can still be performed. The error messages 77*cdf0e10cSrcweir are cumulative. 78*cdf0e10cSrcweir 79*cdf0e10cSrcweir @param TestName The name of the test. Must be an interface, service or implementation name. 80*cdf0e10cSrcweir Note : The name is only used by the test component to distinguish 81*cdf0e10cSrcweir between test scenarios. 82*cdf0e10cSrcweir @param TestObject The instance to be tested. 83*cdf0e10cSrcweir @param hTestHandle Internal test handle. Handle for first test is always 0. 84*cdf0e10cSrcweir Handle of next test is returned by the method. 85*cdf0e10cSrcweir @return Handle of the next test. -1 if this was the last test. 86*cdf0e10cSrcweir 87*cdf0e10cSrcweir @throws IllegalArgumentException 88*cdf0e10cSrcweir if the test does not support TestName or 89*cdf0e10cSrcweir TestObject is null. 90*cdf0e10cSrcweir */ 91*cdf0e10cSrcweir long test( [in] string TestName, 92*cdf0e10cSrcweir [in] com::sun::star::uno::XInterface TestObject, 93*cdf0e10cSrcweir [in] long hTestHandle ) 94*cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException ); 95*cdf0e10cSrcweir 96*cdf0e10cSrcweir //------------------------------------------------------------------------- 97*cdf0e10cSrcweir /**States if one of the last test has failed. This is cumulative. 98*cdf0e10cSrcweir @return true if all test have been passed succesfully. false if an error has occured. 99*cdf0e10cSrcweir 100*cdf0e10cSrcweir */ 101*cdf0e10cSrcweir boolean testPassed(); 102*cdf0e10cSrcweir 103*cdf0e10cSrcweir //------------------------------------------------------------------------- 104*cdf0e10cSrcweir // DOCUMENTATION MISSING FOR XSimpleTest::getErrors 105*cdf0e10cSrcweir sequence<string> getErrors(); 106*cdf0e10cSrcweir 107*cdf0e10cSrcweir //------------------------------------------------------------------------- 108*cdf0e10cSrcweir // DOCUMENTATION MISSING FOR XSimpleTest::getErrorExceptions 109*cdf0e10cSrcweir sequence<any> getErrorExceptions(); 110*cdf0e10cSrcweir 111*cdf0e10cSrcweir //------------------------------------------------------------------------- 112*cdf0e10cSrcweir // DOCUMENTATION MISSING FOR XSimpleTest::getWarnings 113*cdf0e10cSrcweir sequence<string> getWarnings(); 114*cdf0e10cSrcweir 115*cdf0e10cSrcweir}; 116*cdf0e10cSrcweir 117*cdf0e10cSrcweir//============================================================================= 118*cdf0e10cSrcweir 119*cdf0e10cSrcweir}; }; }; }; 120*cdf0e10cSrcweir 121*cdf0e10cSrcweir#endif 122