com.tplan.robot.scheduler

Class TestSuite

java.lang.Object

com.tplan.robot.scheduler.AbstractScheduleElement

com.tplan.robot.scheduler.TestSuite

All Implemented Interfaces:

GenericListener<PropertyChangeListener>, PropertyChangeListener, EventListener

public class TestSuite
extends AbstractScheduleElement
implements PropertyChangeListener

Test suite contains tasks (scripts), report settings and the start type (delayed, date driven, cron based etc.).

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestSuite.ReportLocType Report location type.
static class	TestSuite.StartType Schedule start type.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String name, String value)
void	addTask(Task t)
static Node	exportParams(Element parent, String name, List<ScheduleParameter> params)
Map<String,String>	getAttributes()
Map<Task,Dependency>	getChildren(Task t, Map<Task,Dependency> map)
String	getDisplayName() Get the schedule display name.
int	getExecutionCount()
List<ScheduleParameter>	getInParams()
File	getLastReport() Get location of the last report.
String	getName() Get the schedule name.
List<ScheduleParameter>	getOutParams()
String	getReportFile() Get the custom report file.
TestSuite.ReportLocType	getReportLocationType() Get the report location type.
TestSuite.StartType	getStartType() Get the schedule start type.
String	getSubtype() Get the test suite subtype.
List<Task>	getTasks() Get the list of tasks (scripts).
String	getXslFile() Get the report XSL file which was previously set through the setXslFile(java.lang.String).
boolean	isCopyXsl() Find out whether copying of the XSL file to the schedule report folder is enabled or disabled.
boolean	isReportEnabled() Get the report enable flag.
boolean	isXslEnabled() Find out if the test suite is configured to link the XSL file to the schedule XML report.
void	propertyChange(PropertyChangeEvent evt) Implementation of the PropertyChangeListener interface.
void	setCopyXsl(boolean copyXsl) Enable or disable copying of the XSL file to the schedule report folder.
void	setExecutionCount(int executionCount)
void	setName(String name)
void	setReportEnabled(boolean reportEnabled) Enable or disable the report.
void	setReportLocationType(TestSuite.ReportLocType reportLocationType, String reportFile) Set the report location type.
void	setSubtype(String subtype) Get the test suite subtype.
void	setXslEnabled(boolean xslEnabled) Enable of disable linking of XSL to the schedule XML report.
void	setXslFile(String xslFile) Set a custom XSL to be linked from the schedule XML data.

Methods inherited from class com.tplan.robot.scheduler.AbstractScheduleElement

genericEvent, setChanged

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addAttribute

public void addAttribute(String name,
                         String value)

getAttributes

public Map<String,String> getAttributes()

exportParams

public static Node exportParams(Element parent,
                                String name,
                                List<ScheduleParameter> params)

getName

public String getName()

Get the schedule name.

Returns:

the schedule name.

getDisplayName

public String getDisplayName()

Get the schedule display name. The method returns the schedule name returned by getName() or the schedule file name if the name is not available (is null or empty string).

Returns:

schedule display name.

setName

public void setName(String name)

getExecutionCount

public int getExecutionCount()

Returns:

the executionCount

setExecutionCount

public void setExecutionCount(int executionCount)

Parameters:

executionCount - the executionCount to set

getTasks

public List<Task> getTasks()

Get the list of tasks (scripts).

Returns:

the list of tasks.

addTask

public void addTask(Task t)

getChildren

public Map<Task,Dependency> getChildren(Task t,
                                        Map<Task,Dependency> map)

getStartType

public TestSuite.StartType getStartType()

Get the schedule start type.

Returns:

the start type.

isReportEnabled

public boolean isReportEnabled()

Get the report enable flag.

Returns:

true/false if the report is enabled/disabled.

setReportEnabled

public void setReportEnabled(boolean reportEnabled)

Enable or disable the report.

Parameters:

reportEnabled - true will enable report, false will disable.

getReportLocationType

public TestSuite.ReportLocType getReportLocationType()

Get the report location type.

Returns:

the report location type.

setReportLocationType

public void setReportLocationType(TestSuite.ReportLocType reportLocationType,
                                  String reportFile)

Set the report location type.

Parameters:

reportLocationType - the report location type.

reportFile - the custom report file applicable when the type is being set to TestSuite.ReportLocType.CUSTOM.

getReportFile

public String getReportFile()

Get the custom report file. It is only applicable to the TestSuite.ReportLocType.CUSTOM report location type where the file was previously set through the setReportLocationType(com.tplan.robot.scheduler.TestSuite.ReportLocType, java.lang.String) method. If the report location type is set to TestSuite.ReportLocType.DEFAULT the method may return null.

Returns:

the reportFile

getXslFile

public String getXslFile()

Get the report XSL file which was previously set through the setXslFile(java.lang.String).

Returns:

the report XSL.

setXslFile

public void setXslFile(String xslFile)

Set a custom XSL to be linked from the schedule XML data. This allows to customize the schedule report appearance. If the file is set to null the schedule will internally use the built-in default XSL.

Parameters:

xslFile - a custom XSL file.

isXslEnabled

public boolean isXslEnabled()

Find out if the test suite is configured to link the XSL file to the schedule XML report.

Returns:

true if XSL is enabled or false if disabled. The default value is true (enabled).

setXslEnabled

public void setXslEnabled(boolean xslEnabled)

Enable of disable linking of XSL to the schedule XML report.

Parameters:

xslEnabled - true enables linking, false disables. The default value is true (enabled).

isCopyXsl

public boolean isCopyXsl()

Find out whether copying of the XSL file to the schedule report folder is enabled or disabled.

Returns:

true if XSL copying is enabled or false if disabled. The default value is true (enabled).

setCopyXsl

public void setCopyXsl(boolean copyXsl)

Enable or disable copying of the XSL file to the schedule report folder.

Parameters:

copyXsl - true enables copying, false disables.

getLastReport

public File getLastReport()

Get location of the last report. The file is updated whenever the schedule is started and the report is enabled.

Returns:

file of the last XML report.

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Implementation of the PropertyChangeListener interface. Not to be used externally.

Specified by:

propertyChange in interface PropertyChangeListener

Parameters:

evt - a property change event.

getInParams

public List<ScheduleParameter> getInParams()

Returns:

the inParams

getOutParams

public List<ScheduleParameter> getOutParams()

Returns:

the outParams

getSubtype

public String getSubtype()

Get the test suite subtype. Used for RAP categorization of workitems.

Returns:

the workitem subtype.

Since:

7.0

setSubtype

public void setSubtype(String subtype)

Get the test suite subtype. Used for RAP categorization of workitems.

Parameters:

subtype - the workitem subtype.

Since:

7.0