Package com.piketec.tpt.api.requirements

Class TestCasesImportSettings

java.lang.Object

com.piketec.tpt.api.requirements.TestCasesImportSettings

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CodeBeamerTestCasesImportSettings, PolarionTestCasesImportSettings, TabularTestCasesImportSettings

public abstract class TestCasesImportSettings
extends java.lang.Object
implements java.io.Serializable

The common settings of the requirement import of test cases.
For the test cases import from a CSV file use CsvFileTestCasesImportSettings.
For the test cases import from an Excel file use ExcelFileTestCasesImportSettings.
For the test cases import from Polarion use PolarionTestCasesImportSettings.
For the test cases import from codeBeamer use CodeBeamerTestCasesImportSettings.

Author:

Copyright (c) 2014-2024 PikeTec GmbH - MIT License (MIT) - All rights reserved

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TestCasesImportSettings.SynchronizationMethod	The choice how the importer matches TPT test cases against the imported ones.
static class	TestCasesImportSettings.SynchronizationProperty	The choice which property of TPT test cases the importer matches against the imported ID values.
static class	TestCasesImportSettings.TargetTypeAssignment	The assignment of the name of an imported object type to the TPT type (test case vs. test case group).
static class	TestCasesImportSettings.TestCaseHierarchyCreationMethod	The choice how the importer creates the TPT test case hierarchy.
static class	TestCasesImportSettings.TestCaseType	The choice whether the imported test case should be created in TPT as step list or as time partition test case.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CREATE_NEW_TEST_SET	String constant which represents the creation of a new test set as target of imported test cases.

Constructor Summary

Constructors

Constructor	Description
TestCasesImportSettings()	The constructor for the common settings of the requirement import of test cases. For the test cases import from a CSV file use CsvFileTestCasesImportSettings. For the test cases import from an Excel file use ExcelFileTestCasesImportSettings. For the test cases import from Polarion use PolarionTestCasesImportSettings. For the test cases import from codeBeamer use CodeBeamerTestCasesImportSettings.

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getAutoReviewAttributes()
TestCasesImportSettings.TestCaseHierarchyCreationMethod	getHierarchyCreationMethod()
java.lang.String	getIdAttribute()
TestCasesImportSettings.TestCaseType	getPreferredTestCaseType()
TestCasesImportSettings.SynchronizationMethod	getSyncMethod()
TestCasesImportSettings.SynchronizationProperty	getSyncProperty()
java.lang.String	getTestSetName()
void	setAutoReviewAttributes(java.util.List<java.lang.String> autoReviewAttributes)
void	setHierarchyCreationMethod(TestCasesImportSettings.TestCaseHierarchyCreationMethod hierarchyCreationMethod)
void	setIdAttribute(java.lang.String idAttribute)
void	setPreferredTestCaseType(TestCasesImportSettings.TestCaseType preferredTestCaseType)
void	setSyncMethod(TestCasesImportSettings.SynchronizationMethod syncMethod)
void	setSyncProperty(TestCasesImportSettings.SynchronizationProperty syncProperty)
void	setTestSetName(java.lang.String testSetName)

Methods inherited from class java.lang.Object

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

Field Detail

CREATE_NEW_TEST_SET

public static final java.lang.String CREATE_NEW_TEST_SET

String constant which represents the creation of a new test set as target of imported test cases.

See Also:

Constant Field Values

Constructor Detail

TestCasesImportSettings

public TestCasesImportSettings()

The constructor for the common settings of the requirement import of test cases.
For the test cases import from a CSV file use CsvFileTestCasesImportSettings.
For the test cases import from an Excel file use ExcelFileTestCasesImportSettings.
For the test cases import from Polarion use PolarionTestCasesImportSettings.
For the test cases import from codeBeamer use CodeBeamerTestCasesImportSettings.

Method Detail

getSyncMethod

public TestCasesImportSettings.SynchronizationMethod getSyncMethod()

Returns:

The choice how the importer matches TPT test cases against the imported ones.

setSyncMethod

public void setSyncMethod(TestCasesImportSettings.SynchronizationMethod syncMethod)

Parameters:

syncMethod - The choice how the importer matches TPT test cases against the imported ones.

getSyncProperty

public TestCasesImportSettings.SynchronizationProperty getSyncProperty()

Returns:

The choice which property of TPT test cases the importer matches against the imported ID values. Not relevant if the synchronization method is TestCasesImportSettings.SynchronizationMethod.ALL_NEW.

setSyncProperty

public void setSyncProperty(TestCasesImportSettings.SynchronizationProperty syncProperty)

Parameters:

syncProperty - The choice which property of TPT test cases the importer matches against the imported ID values. Not relevant if the synchronization method is TestCasesImportSettings.SynchronizationMethod.ALL_NEW.

getIdAttribute

public java.lang.String getIdAttribute()

Returns:

The TPT test case attribute that contains the ID to match existing test cases against imported ones. Not relevant if the synchronization method is TestCasesImportSettings.SynchronizationMethod.ALL_NEW or the synchronization property is TestCasesImportSettings.SynchronizationProperty.TPT_ID or TestCasesImportSettings.SynchronizationProperty.NAME. Must be neither null nor empty otherwise.

See Also:

setSyncMethod(SynchronizationMethod)

setIdAttribute

public void setIdAttribute(java.lang.String idAttribute)

Parameters:

idAttribute - The TPT test case attribute that contains the ID to match existing test cases against imported ones. Not relevant if the synchronization method is TestCasesImportSettings.SynchronizationMethod.ALL_NEW or the synchronization property is TestCasesImportSettings.SynchronizationProperty.TPT_ID or TestCasesImportSettings.SynchronizationProperty.NAME. Must be neither null nor empty otherwise.

See Also:

setSyncMethod(SynchronizationMethod)

getHierarchyCreationMethod

public TestCasesImportSettings.TestCaseHierarchyCreationMethod getHierarchyCreationMethod()

Returns:

The choice how the importer creates the TPT test case hierarchy.

setHierarchyCreationMethod

public void setHierarchyCreationMethod(TestCasesImportSettings.TestCaseHierarchyCreationMethod hierarchyCreationMethod)

Parameters:

hierarchyCreationMethod - The choice how the importer creates the TPT test case hierarchy.

getTestSetName

public java.lang.String getTestSetName()

Returns:

Optional choice for the TPT test set as target of imported test cases.
If null, no test set is used and the target is the test cases tree.
If set to "-- Create new test set --" (use constant CREATE_NEW_TEST_SET), a new test set is created.
Otherwise choose a name of an existing test set as target.

setTestSetName

public void setTestSetName(java.lang.String testSetName)

Parameters:

testSetName - Optional choice for the TPT test set as target of imported test cases.
If null, no test set is used and the target is the test cases tree.
If set to "-- Create new test set --" (use constant CREATE_NEW_TEST_SET), a new test set is created.
Otherwise choose a name of an existing test set as target.

getPreferredTestCaseType

public TestCasesImportSettings.TestCaseType getPreferredTestCaseType()

Returns:

The choice whether the imported test case should be created in TPT as step list or as time partition test case.

setPreferredTestCaseType

public void setPreferredTestCaseType(TestCasesImportSettings.TestCaseType preferredTestCaseType)

Parameters:

preferredTestCaseType - The choice whether the imported test case should be created in TPT as step list or as time partition test case.

getAutoReviewAttributes

public java.util.List<java.lang.String> getAutoReviewAttributes()

Returns:

Optional list of column names in the source file for which the automatic review of possible changes of a test case attribute should be enabled.

setAutoReviewAttributes

public void setAutoReviewAttributes(java.util.List<java.lang.String> autoReviewAttributes)

Parameters:

autoReviewAttributes - Optional list of column names in the source file for which the automatic review of possible changes of a test case attribute should be enabled.