Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: test ::

interface XSimpleTest
Description
A simple interface to test a service or interface implementation.

Methods' Summary
testInvariant 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.  
test 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 : These tests should include the testInvariant test. 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.  
testPassed States if one of the last test has failed. This is cumulative.  
getErrors  
getErrorExceptions  
getWarnings  
Methods' Details
testInvariant
void
testInvariant( [in] string  TestName,
[in] ::com::sun::star::uno::XInterface  TestObject )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
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.
Parameter 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.
Parameter TestObject
The instance to be tested.
Throws
IllegalArgumentException if the test does not support TestName or TestObject is null.
test
long
test( [in] string  TestName,
[in] ::com::sun::star::uno::XInterface  TestObject,
[in] long  hTestHandle )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
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 : These tests should include the testInvariant test. 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.
Parameter 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.
Parameter TestObject
The instance to be tested.
Parameter hTestHandle
Internal test handle. Handle for first test is always 0. Handle of next test is returned by the method.
Returns
Handle of the next test. -1 if this was the last test.
Throws
IllegalArgumentException if the test does not support TestName or TestObject is null.
testPassed
boolean
testPassed();

Description
States if one of the last test has failed. This is cumulative.
Returns
true if all test have been passed succesfully. false if an error has occured.
getErrors
sequence< string >
getErrors();

getErrorExceptions
sequence< any >
getErrorExceptions();

getWarnings
sequence< string >
getWarnings();

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.