Package com.piketec.tpt.api.requirements.tabular

Class TabularTestCasesExportSettings

java.lang.Object

com.piketec.tpt.api.requirements.TestCasesExportSettings

com.piketec.tpt.api.requirements.tabular.TabularTestCasesExportSettings

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CsvFileTestCasesExportSettings, ExcelFileTestCasesExportSettings

public abstract class TabularTestCasesExportSettings
extends TestCasesExportSettings

The common settings for the requirements export of test cases to a CVS or an Excel file.
For the test cases export to a CSV file use CsvFileTestCasesExportSettings.
For the test cases export to an Excel file use ExcelFileTestCasesExportSettings.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TabularTestCasesExportSettings(java.lang.String exportFilePath)	The constructor for the common settings of the requirements export of test cases to a CVS or an Excel file. For the test cases export to a CSV file use CsvFileTestCasesExportSettings. For the test cases export to an Excel file use ExcelFileTestCasesExportSettings.

Method Summary

Modifier and Type	Method	Description
java.util.List<Pair<java.lang.String,java.lang.String>>	getAssignments()
java.lang.String	getExportFilePath()
java.lang.String	getTestSet()
boolean	isExportGroups()
boolean	isWithHeaderLine()
void	setAssignments(java.util.List<Pair<java.lang.String,java.lang.String>> assignments)
void	setExportGroups(boolean exportGroups)
void	setTestSet(java.lang.String testSet)
void	setWithHeaderline(boolean withHeaderLine)

Methods inherited from class java.lang.Object

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

Constructor Detail

TabularTestCasesExportSettings

public TabularTestCasesExportSettings(java.lang.String exportFilePath)

The constructor for the common settings of the requirements export of test cases to a CVS or an Excel file.
For the test cases export to a CSV file use CsvFileTestCasesExportSettings.
For the test cases export to an Excel file use ExcelFileTestCasesExportSettings.

Parameters:

exportFilePath - The path of the target file for the export.

Method Detail

setWithHeaderline

public void setWithHeaderline(boolean withHeaderLine)

Parameters:

withHeaderLine - Whether the first line is a header.

isWithHeaderLine

public boolean isWithHeaderLine()

Returns:

Whether the first line is a header.

setExportGroups

public void setExportGroups(boolean exportGroups)

Parameters:

exportGroups - Whether test case groups are exported.

isExportGroups

public boolean isExportGroups()

Returns:

Whether test case groups are exported.

setTestSet

public void setTestSet(java.lang.String testSet)

Parameters:

testSet - The name of the test set with the contained test cases for the export. If null, all test cases are exported.

getTestSet

public java.lang.String getTestSet()

Returns:

The name of the test set with the contained test cases for the export. If null, all test cases are exported.

setAssignments

public void setAssignments(java.util.List<Pair<java.lang.String,java.lang.String>> assignments)

Parameters:

assignments - The assignment of test cases fields and attributes to export attributes. If null, the default assignments will be used. If a list is given, the export will be restricted to its elements.

getAssignments

public java.util.List<Pair<java.lang.String,java.lang.String>> getAssignments()

Returns:

The assignment of test cases fields and attributes to export attributes. If null, the default assignments will be used. If a list is given, the export will be restricted to its elements.

getExportFilePath

public java.lang.String getExportFilePath()

Returns:

The path of the target file for the export.