Package com.piketec.tpt.api.requirements

Class RequirementsExportSettings

java.lang.Object

com.piketec.tpt.api.requirements.RequirementsExportSettings

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CsvFileRequirementsExportSettings, ExcelFileRequirementsExportSettings

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

The common settings for the requirements export to a file.
For the requirements export to a CSV file use CsvFileRequirementsExportSettings.
For the requirements export to an Excel file use ExcelFileRequirementsExportSettings.

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
RequirementsExportSettings(java.lang.String exportFilePath)	The constructor for the common settings of the requirements export to a file. For the requirements export to a CSV file use CsvFileRequirementsExportSettings. For the requirements export to an Excel file use ExcelFileRequirementsExportSettings.

Method Summary

Modifier and Type	Method	Description
java.util.List<Pair<java.lang.String,java.lang.String>>	getAssignments()
java.lang.String	getDocument()
java.lang.String	getExportFilePath()
boolean	isWithHeaderLine()
void	setAssignments(java.util.List<Pair<java.lang.String,java.lang.String>> assignments)
void	setDocument(java.lang.String document)
void	setWithHeaderLine(boolean withHeaderLine)

Methods inherited from class java.lang.Object

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

Constructor Detail

RequirementsExportSettings

public RequirementsExportSettings(java.lang.String exportFilePath)

The constructor for the common settings of the requirements export to a file.
For the requirements export to a CSV file use CsvFileRequirementsExportSettings.
For the requirements export to an Excel file use ExcelFileRequirementsExportSettings.

Parameters:

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

Method Detail

getExportFilePath

public java.lang.String getExportFilePath()

Returns:

The path of the target file for the export.

isWithHeaderLine

public boolean isWithHeaderLine()

Returns:

Whether the first line is a header.

setWithHeaderLine

public void setWithHeaderLine(boolean withHeaderLine)

Parameters:

withHeaderLine - Whether the first line is a header.

getAssignments

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

Returns:

The assignment of TPT requirement fields, attributes or other details to export attributes. If null, the default assignments will be used. If a list is given, the export will be restricted to its elements.

setAssignments

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

Parameters:

assignments - The assignment of TPT requirement fields, attributes or other details to export attributes. If null, the default assignments will be used. If a list is given, the export will be restricted to its elements.

getDocument

public java.lang.String getDocument()

Returns:

null, if only the requirements for this document are exported.
Returns null, if all requirements are exported.

setDocument

public void setDocument(java.lang.String document)

Parameters:

document - If not set to null, only the requirements for this document are exported.
If set to null, all requirements are exported.