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_XSimpleTest_idl__ 24cdf0e10cSrcweir#define __com_sun_star_test_XSimpleTest_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 35cdf0e10cSrcweir//============================================================================= 36cdf0e10cSrcweir 37cdf0e10cSrcweirmodule com { module sun { module star { module test { 38cdf0e10cSrcweir 39cdf0e10cSrcweir//============================================================================= 40cdf0e10cSrcweir/** 41cdf0e10cSrcweir A simple interface to test a service or interface implementation. 42cdf0e10cSrcweir*/ 43cdf0e10cSrcweirpublished interface XSimpleTest: com::sun::star::uno::XInterface 44cdf0e10cSrcweir{ 45cdf0e10cSrcweir //------------------------------------------------------------------------- 46cdf0e10cSrcweir /** 47cdf0e10cSrcweir Test the object TestObject against the test specified with TestName. This test 48cdf0e10cSrcweir does not change the semantic state of the object, so it can be called on a existing 49cdf0e10cSrcweir component that will used further on. 50cdf0e10cSrcweir Note : This can be a strong test limitation. There are some components, that cannot 51cdf0e10cSrcweir perform their full test scenario. 52cdf0e10cSrcweir @param TestName the name of the test. Must be an interface, service or implementation name. 53cdf0e10cSrcweir Note : The name is only used by the test component to distinguish 54cdf0e10cSrcweir between test scenarios. 55cdf0e10cSrcweir @param TestObject The instance to be tested. 56cdf0e10cSrcweir 57cdf0e10cSrcweir @throws IllegalArgumentException 58cdf0e10cSrcweir if the test does not support TestName or TestObject is null. 59cdf0e10cSrcweir */ 60cdf0e10cSrcweir void testInvariant( [in] string TestName, 61cdf0e10cSrcweir [in] com::sun::star::uno::XInterface TestObject ) 62cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException ); 63cdf0e10cSrcweir 64cdf0e10cSrcweir //------------------------------------------------------------------------- 65cdf0e10cSrcweir /** 66cdf0e10cSrcweir Test the object TestObject against the test specified with TestName. This test 67cdf0e10cSrcweir changes the state of the object. The object may be useless afterwards. 68cdf0e10cSrcweir (e.g. a closed XOutputStream). The method in general may be called multipe times with a new 69cdf0e10cSrcweir test object instance. 70cdf0e10cSrcweir Note : These tests should include the testInvariant test. 71cdf0e10cSrcweir Note : Each test scenario should be independent of each other, so even if a scenario 72cdf0e10cSrcweir didn't pass the test, the other test can still be performed. The error messages 73cdf0e10cSrcweir are cumulative. 74cdf0e10cSrcweir 75cdf0e10cSrcweir @param TestName The name of the test. Must be an interface, service or implementation name. 76cdf0e10cSrcweir Note : The name is only used by the test component to distinguish 77cdf0e10cSrcweir between test scenarios. 78cdf0e10cSrcweir @param TestObject The instance to be tested. 79cdf0e10cSrcweir @param hTestHandle Internal test handle. Handle for first test is always 0. 80cdf0e10cSrcweir Handle of next test is returned by the method. 81cdf0e10cSrcweir @return Handle of the next test. -1 if this was the last test. 82cdf0e10cSrcweir 83cdf0e10cSrcweir @throws IllegalArgumentException 84cdf0e10cSrcweir if the test does not support TestName or 85cdf0e10cSrcweir TestObject is null. 86cdf0e10cSrcweir */ 87cdf0e10cSrcweir long test( [in] string TestName, 88cdf0e10cSrcweir [in] com::sun::star::uno::XInterface TestObject, 89cdf0e10cSrcweir [in] long hTestHandle ) 90cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException ); 91cdf0e10cSrcweir 92cdf0e10cSrcweir //------------------------------------------------------------------------- 93cdf0e10cSrcweir /**States if one of the last test has failed. This is cumulative. 94cdf0e10cSrcweir @return true if all test have been passed succesfully. false if an error has occured. 95cdf0e10cSrcweir 96cdf0e10cSrcweir */ 97cdf0e10cSrcweir boolean testPassed(); 98cdf0e10cSrcweir 99cdf0e10cSrcweir //------------------------------------------------------------------------- 100cdf0e10cSrcweir // DOCUMENTATION MISSING FOR XSimpleTest::getErrors 101cdf0e10cSrcweir sequence<string> getErrors(); 102cdf0e10cSrcweir 103cdf0e10cSrcweir //------------------------------------------------------------------------- 104cdf0e10cSrcweir // DOCUMENTATION MISSING FOR XSimpleTest::getErrorExceptions 105cdf0e10cSrcweir sequence<any> getErrorExceptions(); 106cdf0e10cSrcweir 107cdf0e10cSrcweir //------------------------------------------------------------------------- 108cdf0e10cSrcweir // DOCUMENTATION MISSING FOR XSimpleTest::getWarnings 109cdf0e10cSrcweir sequence<string> getWarnings(); 110cdf0e10cSrcweir 111cdf0e10cSrcweir}; 112cdf0e10cSrcweir 113cdf0e10cSrcweir//============================================================================= 114cdf0e10cSrcweir 115cdf0e10cSrcweir}; }; }; }; 116cdf0e10cSrcweir 117cdf0e10cSrcweir#endif 118