org.teiid.test.client

Interface TestResult

All Known Implementing Classes:

TestResultStat

public interface TestResult

The TestResult represents the results from a single test. A single test can include 1 or more sql commands that are considered 1 inclusive test.

Author:

vanhalbert

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TestResult.RESULT_STATE The RESULT_STATE is the value assigned based the result of the executed query test
static interface	TestResult.RESULT_STATE_STRING

Method Summary

Modifier and Type	Method and Description
long	getBeginTS() Return the time (in a long value) that this query started.
long	getEndTS() Return the time (in a long value) that this query ended
String	getErrorfile()
Throwable	getException()
String	getExceptionMsg() If the result from this query produced an exception, then this method should return the String representation of the exception.
String	getQuery() Return the query that was executed in order to produce this result.
String	getQueryID() Return the id that uniquely identifies the query within the query set getQuerySetID().
String	getQuerySetID() Return the id the uniquely identifies the query set.
String	getResultStatusString() Return the result status in string format.
int	getStatus() Return the status of the execution of this query {@link #getQuery();
void	setBeginTS(long beginTS)
void	setEndTS(long endTS)
void	setErrorFile(String errorFile)
void	setException(Throwable error) Set the exception that indicates the reason why there is a problem with the results.
void	setExceptionMessage(String errorMsg) Set the error message relating to the reason why there is a problem with the results.
void	setStatus(int status) Call to set the status for this test result.

Method Detail

getQuerySetID

String getQuerySetID()

Return the id the uniquely identifies the query set.

Returns:

String is the query set id

getQueryID

String getQueryID()

Return the id that uniquely identifies the query within the query set getQuerySetID().

Returns:

Since:

getQuery

String getQuery()

Return the query that was executed in order to produce this result.

Returns:

Since:

getStatus

int getStatus()

Return the status of the execution of this query {@link #getQuery();

Returns:

Since:

See Also:

TestResult.RESULT_STATE

setStatus

void setStatus(int status)

Call to set the status for this test result.

Parameters:

status -

See Also:

TestResult.RESULT_STATE

getResultStatusString

String getResultStatusString()

Return the result status in string format.

Returns:

String

getExceptionMsg

String getExceptionMsg()

If the result from this query produced an exception, then this method should return the String representation of the exception.

Returns:

Since:

getException

Throwable getException()

setException

void setException(Throwable error)

Set the exception that indicates the reason why there is a problem with the results. Call setExceptionMessage(String) to display a different message in the summary file.

Parameters:

error -

setExceptionMessage

void setExceptionMessage(String errorMsg)

Set the error message relating to the reason why there is a problem with the results.

Parameters:

errorMsg -

getBeginTS

long getBeginTS()

Return the time (in a long value) that this query started.

Returns:

long representation of begin time

Since:

setBeginTS

void setBeginTS(long beginTS)

getEndTS

long getEndTS()

Return the time (in a long value) that this query ended

Returns:

long representation of end time

Since:

setEndTS

void setEndTS(long endTS)

getErrorfile

String getErrorfile()

Returns:

Returns the name of errorfile where the error results were written.

setErrorFile

void setErrorFile(String errorFile)