Package com.piketec.tpt.api.requirements.polarion

Class PolarionTestCasesExportSettings

java.lang.Object

com.piketec.tpt.api.requirements.TestCasesExportSettings

com.piketec.tpt.api.requirements.polarion.PolarionTestCasesExportSettings

All Implemented Interfaces:

java.io.Serializable

public class PolarionTestCasesExportSettings
extends TestCasesExportSettings

The settings for the export of test cases to Polarion.

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	PolarionTestCasesExportSettings.TCAttributeToWorkItemFieldAssignment	The assignment of a TPT test case attribute to a Polarion Work Item field.

Constructor Summary

Constructors

Constructor	Description
PolarionTestCasesExportSettings(java.lang.String projectId)	The constructor for the settings of the export of test cases to Polarion.

Method Summary

Modifier and Type	Method	Description
java.util.List<PolarionTestCasesExportSettings.TCAttributeToWorkItemFieldAssignment>	getAttributeAssignments()
java.lang.String	getIdAttribute()
java.lang.String	getLinkRole()
java.lang.String	getProjectId()
java.lang.String	getTestSet()
java.lang.String	getWorkItemType()
boolean	isExportDescription()
boolean	isRemoveUnexportedLinks()
void	setAttributeAssignments(java.util.List<PolarionTestCasesExportSettings.TCAttributeToWorkItemFieldAssignment> attributeAssignments)
void	setExportDescription(boolean exportDescription)
void	setIdAttribute(java.lang.String idAttribute)
void	setLinkRole(java.lang.String linkRole)
void	setRemoveUnexportedLinks(boolean removeUnexportedLinks)
void	setTestSet(java.lang.String testSet)
void	setWorkItemType(java.lang.String workItemType)

Methods inherited from class java.lang.Object

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

Constructor Detail

PolarionTestCasesExportSettings

public PolarionTestCasesExportSettings(java.lang.String projectId)

The constructor for the settings of the export of test cases to Polarion.

Parameters:

projectId - The ID of the project in Polarion.

Method Detail

getProjectId

public java.lang.String getProjectId()

Returns:

The ID of the project in Polarion.

getTestSet

public java.lang.String getTestSet()

Returns:

The TPT test set to export a subset of TPT test cases. If null, all test cases are exported.

setTestSet

public void setTestSet(java.lang.String testSet)

Parameters:

testSet - The TPT test set to export a subset of TPT test cases. If null, all test cases are exported.

isExportDescription

public boolean isExportDescription()

Returns:

Whether to export the TPT description to the description field in Polarion. Note that the description will be exported as plain text.

setExportDescription

public void setExportDescription(boolean exportDescription)

Parameters:

exportDescription - Whether to export the TPT description to the description field in Polarion. Note that the description will be exported as plain text.

getWorkItemType

public java.lang.String getWorkItemType()

Returns:

The ID of the Polarion work item type to use for the exported test cases.

setWorkItemType

public void setWorkItemType(java.lang.String workItemType)

Parameters:

workItemType - The ID of the Polarion work item type to use for the exported test cases.

getIdAttribute

public java.lang.String getIdAttribute()

Returns:

The TPT test case attribute which contains the Polarion IDs. It will be used to update test cases which already are known in Polarion. Furthermore the IDs of newly created work items will be applied to the respective TPT test cases.

setIdAttribute

public void setIdAttribute(java.lang.String idAttribute)

Parameters:

idAttribute - The TPT test case attribute which contains the Polarion IDs. It will be used to update test cases which already are known in Polarion. Furthermore the IDs of newly created work items will be applied to the respective TPT test cases.

getAttributeAssignments

public java.util.List<PolarionTestCasesExportSettings.TCAttributeToWorkItemFieldAssignment> getAttributeAssignments()

Returns:

The list of assignments of TPT test case attributes to Polarion Work Item fields.

setAttributeAssignments

public void setAttributeAssignments(java.util.List<PolarionTestCasesExportSettings.TCAttributeToWorkItemFieldAssignment> attributeAssignments)

Parameters:

attributeAssignments - The list of assignments of TPT test case attributes to Polarion Work Item fields.

getLinkRole

public java.lang.String getLinkRole()

Returns:

The ID of the Polarion role of the exported links. If null, no links are exported.

setLinkRole

public void setLinkRole(java.lang.String linkRole)

Parameters:

linkRole - The ID of the Polarion role of the exported links. If set to null, no links are exported.

isRemoveUnexportedLinks

public boolean isRemoveUnexportedLinks()

Returns:

Whether to remove unexported links. If true, Polarion links of the same role as specified that are not exported are removed.

See Also:

setLinkRole(String)

setRemoveUnexportedLinks

public void setRemoveUnexportedLinks(boolean removeUnexportedLinks)

Parameters:

removeUnexportedLinks - Whether to remove unexported links. If set to true, Polarion links of the same role as specified that are not exported are removed.

See Also:

setLinkRole(String)