udkapi/com/sun/star/test/XSimpleTest.idl

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