Package com.piketec.tpt.api.requirements

Class RequirementsImportSettings

java.lang.Object

com.piketec.tpt.api.requirements.RequirementsImportSettings

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CodeBeamerRequirementsImportSettings, PolarionRequirementsImportSettings, ReqIfRequirementsImportSettings, TabularRequirementsImportSettings

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

The common settings for the requirements import.
For the requirements import from a CSV file use CsvFileRequirementsImportSettings.
For the requirements import from an Excel file use ExcelFileRequirementsImportSettings.
For the requirements import from Polarion use PolarionRequirementsImportSettings.
For the requirements import from codeBeamer use CodeBeamerRequirementsImportSettings.
For the requirements import from refIF use ReqIfRequirementsImportSettings.

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor

Description

RequirementsImportSettings()

The constructor for the common settings of the requirements import. For the requirements import from a CSV file use CsvFileRequirementsImportSettings. For the requirements import from an Excel file use ExcelFileRequirementsImportSettings. For the requirements import from Polarion use PolarionRequirementsImportSettings. For the requirements import from codeBeamer use CodeBeamerRequirementsImportSettings. For the requirements import from refIF use ReqIfRequirementsImportSettings.

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getAutoReviewColumns()
java.lang.String	getDocument()
void	setAutoReviewColumns(java.util.List<java.lang.String> autoReviewColumns)
void	setDocument(java.lang.String document)

Methods inherited from class java.lang.Object

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

Constructor Detail

RequirementsImportSettings

public RequirementsImportSettings()

The constructor for the common settings of the requirements import.
For the requirements import from a CSV file use CsvFileRequirementsImportSettings.
For the requirements import from an Excel file use ExcelFileRequirementsImportSettings.
For the requirements import from Polarion use PolarionRequirementsImportSettings.
For the requirements import from codeBeamer use CodeBeamerRequirementsImportSettings.
For the requirements import from refIF use ReqIfRequirementsImportSettings.

Method Detail

getDocument

public java.lang.String getDocument()

Returns:

The name of the document. An empty string represents the default document.
The requirements are imported in the document with this name. If the target document exists, it will be updated.

setDocument

public void setDocument(java.lang.String document)

Parameters:

document - The name of the document. An empty string represents the default document.
The requirements are imported in the document with this name. If the target document exists, it will be updated.

getAutoReviewColumns

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

Returns:

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

setAutoReviewColumns

public void setAutoReviewColumns(java.util.List<java.lang.String> autoReviewColumns)

Parameters:

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