JTR 4.0 API Documentation

jtr.runners
Interface IRunnerClean

All Known Subinterfaces:
IRunner, IRunnerJMS, IRunnerParameterized, IRunnerPooled, IRunnerWs
All Known Implementing Classes:
AbstractJMSRunner, AbstractRunner, AbstractRunnerAncestor, AbstractWsRunner

public interface IRunnerClean

This interface represents a runner in its CLEAN state.
This means that the runner has simply been created but not parameterized yet.
The next admitted state can only be PARAMETERIZED.

Since:
1.0
Version:
4.0
Author:
Francesco Russo (frusso@dev.java.net)

Method Summary
 java.lang.String getDefaultName()
          Get the JTR-assigned unique name of the current runner.
 EnterpriseConfig getEnterprise()
          Get the enterprise configuration associated with the current runner.
 int getInstanceCount()
          Get the number of instances that must be active, according to the jtr.xml, during the test-suite.
 java.lang.String getName()
          Get the logical name of the current runner.
 IOutcomeFactory getOutcomeFactory()
          Get the factory in charge of instantiating IOutCome instances.
 ParametersMap getParameters()
          Get the paramters for the current runner.
 IParamsAssigner getParamsAssigner()
          Get the assigner in charge of performing the parameters injection into the current runner.
 int getRuns()
          Get the total number of runs this runner has to execute.
 long getSleepTime()
          Get the sleep time value assigned to the current runner.
 TestOutcomeTable getTestOutcomeTable()
          Get the TestOutcomeTable instance where the runner logs all the experienced error conditions.
 void setEnterprise(EnterpriseConfig enterprise)
          Set the enterprise configuration associated with the current runner.
 void setInstanceCount(int i)
          Set the number of instances that must be active, according to the jtr.xml, during the test-suite.
 void setName(java.lang.String name)
          Set the logical name of the current runner.
 void setOutcomeFactory(IOutcomeFactory outcomeFactory)
          Set the factory in charge of instantiating IOutCome instances.
 void setParameters(ParametersMap params)
          Set the paramters for the current runner.
 void setParamsAssigner(IParamsAssigner paramsAssigner)
          Set the assigner in charge of performing the parameters injection into the current runner.
 void setRuns(int runs)
          Set the total number of runs this runner has to execute.
 void setSleepTime(long sleepTime)
          Set the sleep time value assigned to the current runner.
 void setTestCompletionListener(ITestCompletionListener testComplLsnr)
          This method assigns an ITestCompletionListener instance to a runner in CLEAN state.
 void setTestOutcomeTable(TestOutcomeTable testOutcomeTable)
          Set the TestOutcomeTable instance where the runner logs all the experienced error conditions.
 

Method Detail

setName

void setName(java.lang.String name)
Set the logical name of the current runner.

Parameters:
name - String

getName

java.lang.String getName()
Get the logical name of the current runner.

Returns:
String

getDefaultName

java.lang.String getDefaultName()
Get the JTR-assigned unique name of the current runner.

Returns:
String

getEnterprise

EnterpriseConfig getEnterprise()
Get the enterprise configuration associated with the current runner.

Returns:
EnterpriseConfig

setEnterprise

void setEnterprise(EnterpriseConfig enterprise)
Set the enterprise configuration associated with the current runner.

Parameters:
enterprise - EnterpriseConfig

getRuns

int getRuns()
Get the total number of runs this runner has to execute.

Returns:
int

setRuns

void setRuns(int runs)
Set the total number of runs this runner has to execute.

Parameters:
runs - int

getSleepTime

long getSleepTime()
Get the sleep time value assigned to the current runner.

Returns:
long

setSleepTime

void setSleepTime(long sleepTime)
Set the sleep time value assigned to the current runner.

Parameters:
sleepTime - long

setParameters

void setParameters(ParametersMap params)
Set the paramters for the current runner.

Parameters:
params -

getParameters

ParametersMap getParameters()
Get the paramters for the current runner.

Returns:
ParametersMap

getParamsAssigner

IParamsAssigner getParamsAssigner()
Get the assigner in charge of performing the parameters injection into the current runner.

Returns:
IParamsAssigner

setParamsAssigner

void setParamsAssigner(IParamsAssigner paramsAssigner)
Set the assigner in charge of performing the parameters injection into the current runner.

Parameters:
paramsAssigner - IParamsAssigner

getTestOutcomeTable

TestOutcomeTable getTestOutcomeTable()
Get the TestOutcomeTable instance where the runner logs all the experienced error conditions.

Returns:
TestOutcomeTable

setTestOutcomeTable

void setTestOutcomeTable(TestOutcomeTable testOutcomeTable)
Set the TestOutcomeTable instance where the runner logs all the experienced error conditions.

Parameters:
testOutcomeTable - TestOutcomeTable

getOutcomeFactory

IOutcomeFactory getOutcomeFactory()
Get the factory in charge of instantiating IOutCome instances.

Returns:
IOutcomeFactory

setOutcomeFactory

void setOutcomeFactory(IOutcomeFactory outcomeFactory)
Set the factory in charge of instantiating IOutCome instances.

Parameters:
outcomeFactory - IOutcomeFactory

setInstanceCount

void setInstanceCount(int i)
Set the number of instances that must be active, according to the jtr.xml, during the test-suite.

Parameters:
i - The number of instances

getInstanceCount

int getInstanceCount()
Get the number of instances that must be active, according to the jtr.xml, during the test-suite.

Returns:
The number of instances

setTestCompletionListener

void setTestCompletionListener(ITestCompletionListener testComplLsnr)
This method assigns an ITestCompletionListener instance to a runner in CLEAN state. This assignment can be performed for just one time in a JTR test-session for each runner instance.
Note: it is legal for this instance to be always null for runner instances started on JTR passive-nodes.

Parameters:
testComplLsnr - The listener instance

The JTR Project is licensed under GPL version 2