TestScenario (WSO2 TestGrid Project - Common POM 1.0.4 API)

java.lang.Object
- org.wso2.testgrid.common.AbstractUUIDEntity
- - org.wso2.testgrid.common.TestScenario

All Implemented Interfaces:

Serializable
```
@Entity
public class TestScenario
extends AbstractUUIDEntity
implements Serializable
```
Defines a model object of TestScenario with required attributes.

Since:

1.0.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DESCRIPTION_COLUMN`
`static String`	`NAME_COLUMN` Column names of the table.
`static String`	`POST_SCRIPT_STATUS_COLUMN`
`static String`	`PRE_SCRIPT_STATUS_COLUMN`
`static String`	`STATUS_COLUMN`
`static String`	`TEST_PLAN_COLUMN`
`static String`	`TEST_SCENARIO_TABLE` Test plan table name.

Fields inherited from class org.wso2.testgrid.common.AbstractUUIDEntity
ID_COLUMN

Constructor Summary

Constructors
Constructor and Description

TestScenario()

Constructors
Constructor and Description
`TestScenario()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTestCase(TestCase testCase)` Adds a test case to the test case list.
`String`	`getConfigChangeSetDescription()` Get config change set description for current scenario
`String`	`getConfigChangeSetName()` Get config change set name for a current scenario
`String`	`getDescription()` Returns the description of the test scenario.
`String`	`getDir()` Returns the directory of the test scenario.
`String`	`getName()` Returns the name of the test scenario.
`String`	`getOutputDir()`
`List<List<String>>`	`getPerformanceTestResults()` Returns the performance results data section
`Status`	`getStatus()` Returns the status of the test scenario.
`List<String>`	`getSummaryGraphs()` Returns a List of Paths referencing the summary graphs
`List<TestCase>`	`getTestCases()` Returns the associated test cases list.
`TestPlan`	`getTestPlan()` Returns the test plan associated with this test scenario.
`boolean`	`isPostScriptSuccessful()` Checks if post script is successful.
`boolean`	`isPreScriptSuccessful()` Checks if pre script is successful.
`void`	`setConfigChangeSetDescription(String configChangeSetDescription)` Set config change set description for current scenario
`void`	`setConfigChangeSetName(String configChangeSetName)` Set config change set name for current scenario
`void`	`setDescription(String description)` Sets the test scenario description.
`void`	`setDir(String dir)` Sets the test scenario directory.
`void`	`setIsPostScriptSuccessful(boolean isPostScriptSuccessful)` Sets the status of the post script execution.
`void`	`setIsPreScriptSuccessful(boolean isPreScriptSuccessful)` Sets the status of the pre script execution.
`void`	`setName(String name)` Sets the test scenario name.
`void`	`setOutputDir(String outputDir)`
`void`	`setPerformanceTestResults(List<List<String>> performanceTestResults)` Set the PerformanceTest results data
`void`	`setStatus(Status status)` Sets the test scenario status.
`void`	`setSummaryGraphs(List<String> summaryGraphs)` Set the performance summary graphs list
`void`	`setTestCases(List<TestCase> testCases)` Sets the associated test cases list.
`void`	`setTestPlan(TestPlan testPlan)` Sets the test plan associated with this test scenario.
`String`	`toString()`

Methods inherited from class org.wso2.testgrid.common.AbstractUUIDEntity
generateUUID, getCreatedTimestamp, getId, getModifiedTimestamp, setCreatedTimestamp, setId, setModifiedTimestamp

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TEST_SCENARIO_TABLE
```
public static final String TEST_SCENARIO_TABLE
```
    Test plan table name.
    
    See Also:
    
    Constant Field Values
  - NAME_COLUMN
```
public static final String NAME_COLUMN
```
    Column names of the table.
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION_COLUMN
```
public static final String DESCRIPTION_COLUMN
```
    See Also:
    
    Constant Field Values
  - STATUS_COLUMN
```
public static final String STATUS_COLUMN
```
    See Also:
    
    Constant Field Values
  - PRE_SCRIPT_STATUS_COLUMN
```
public static final String PRE_SCRIPT_STATUS_COLUMN
```
    See Also:
    
    Constant Field Values
  - POST_SCRIPT_STATUS_COLUMN
```
public static final String POST_SCRIPT_STATUS_COLUMN
```
    See Also:
    
    Constant Field Values
  - TEST_PLAN_COLUMN
```
public static final String TEST_PLAN_COLUMN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TestScenario
```
public TestScenario()
```
- Method Detail
  - getName
```
public String getName()
```
    Returns the name of the test scenario.
    
    Returns:
    
    test scenario name
  - setName
```
public void setName(String name)
```
    Sets the test scenario name.
    
    Parameters:
    
    name - test scenario name
  - getOutputDir
```
public String getOutputDir()
```
  - setOutputDir
```
public void setOutputDir(String outputDir)
```
  - getDescription
```
public String getDescription()
```
    Returns the description of the test scenario.
    
    Returns:
    
    test scenario description
  - setDescription
```
public void setDescription(String description)
```
    Sets the test scenario description.
    
    Parameters:
    
    description - test scenario description
  - getDir
```
public String getDir()
```
    Returns the directory of the test scenario.
    
    Returns:
    
    test scenario directory
  - setDir
```
public void setDir(String dir)
```
    Sets the test scenario directory.
    
    Parameters:
    
    dir - test scenario directory
  - getStatus
```
public Status getStatus()
```
    Returns the status of the test scenario.
    
    Returns:
    
    test scenario status
  - setStatus
```
public void setStatus(Status status)
```
    Sets the test scenario status.
    
    Parameters:
    
    status - test scenario status
  - isPreScriptSuccessful
```
public boolean isPreScriptSuccessful()
```
    Checks if pre script is successful.
    
    Returns:
    
    true if the pre script is successful, false otherwise
  - setIsPreScriptSuccessful
```
public void setIsPreScriptSuccessful(boolean isPreScriptSuccessful)
```
    Sets the status of the pre script execution.
    
    Parameters:
    
    isPreScriptSuccessful - Status of pre script execution
  - isPostScriptSuccessful
```
public boolean isPostScriptSuccessful()
```
    Checks if post script is successful.
    
    Returns:
    
    true if the post script is successful, false otherwise
  - setIsPostScriptSuccessful
```
public void setIsPostScriptSuccessful(boolean isPostScriptSuccessful)
```
    Sets the status of the post script execution.
    
    Parameters:
    
    isPostScriptSuccessful - Status of the post script execution
  - getConfigChangeSetName
```
public String getConfigChangeSetName()
```
    Get config change set name for a current scenario
    
    Returns:
    
    config change set name
  - setConfigChangeSetName
```
public void setConfigChangeSetName(String configChangeSetName)
```
    Set config change set name for current scenario
    
    Parameters:
    
    configChangeSetName - config change set name
  - getConfigChangeSetDescription
```
public String getConfigChangeSetDescription()
```
    Get config change set description for current scenario
    
    Returns:
    
    config change set name
  - setConfigChangeSetDescription
```
public void setConfigChangeSetDescription(String configChangeSetDescription)
```
    Set config change set description for current scenario
    
    Parameters:
    
    configChangeSetDescription - config change set description
  - getTestPlan
```
public TestPlan getTestPlan()
```
    Returns the test plan associated with this test scenario.
    
    Returns:
    
    test plan associated with this test scenario
  - setTestPlan
```
public void setTestPlan(TestPlan testPlan)
```
    Sets the test plan associated with this test scenario.
    
    Parameters:
    
    testPlan - test plan associated with this test scenario
  - getTestCases
```
public List<TestCase> getTestCases()
```
    Returns the associated test cases list.
    
    Returns:
    
    associated test cases list
  - setTestCases
```
public void setTestCases(List<TestCase> testCases)
```
    Sets the associated test cases list.
    
    Parameters:
    
    testCases - associated test cases list
  - addTestCase
```
public void addTestCase(TestCase testCase)
```
    Adds a test case to the test case list.
    
    Parameters:
    
    testCase - test case to be added to the list
  - getPerformanceTestResults
```
public List<List<String>> getPerformanceTestResults()
```
    Returns the performance results data section
    
    Returns:
    
    List of List of Strings containing the CSV data
  - setPerformanceTestResults
```
public void setPerformanceTestResults(List<List<String>> performanceTestResults)
```
    Set the PerformanceTest results data
    
    Parameters:
    
    performanceTestResults - List of List of string containing the performance data
  - getSummaryGraphs
```
public List<String> getSummaryGraphs()
```
    Returns a List of Paths referencing the summary graphs
    
    Returns:
    
    List of path objects containing the graphs
  - setSummaryGraphs
```
public void setSummaryGraphs(List<String> summaryGraphs)
```
    Set the performance summary graphs list
    
    Parameters:
    
    summaryGraphs - List of Paths referencing the graphs
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TestScenario

Field Summary

Fields inherited from class org.wso2.testgrid.common.AbstractUUIDEntity

Constructor Summary

Method Summary

Methods inherited from class org.wso2.testgrid.common.AbstractUUIDEntity

Methods inherited from class java.lang.Object

Field Detail

TEST_SCENARIO_TABLE

NAME_COLUMN

DESCRIPTION_COLUMN

STATUS_COLUMN

PRE_SCRIPT_STATUS_COLUMN

POST_SCRIPT_STATUS_COLUMN

TEST_PLAN_COLUMN

Constructor Detail

TestScenario

Method Detail

getName

setName

getOutputDir

setOutputDir

getDescription

setDescription

getDir

setDir

getStatus

setStatus

isPreScriptSuccessful

setIsPreScriptSuccessful

isPostScriptSuccessful

setIsPostScriptSuccessful

getConfigChangeSetName

setConfigChangeSetName

getConfigChangeSetDescription

setConfigChangeSetDescription

getTestPlan

setTestPlan

getTestCases

setTestCases

addTestCase

getPerformanceTestResults

setPerformanceTestResults

getSummaryGraphs

setSummaryGraphs

toString