Package com.piketec.tpt.api.requirements.codebeamer

Class CodeBeamerRequirementsImportSettings

  • All Implemented Interfaces:
    java.io.Serializable
    public class CodeBeamerRequirementsImportSettings
extends RequirementsImportSettings
    The settings for the requirements import from codeBeamer.
    Author:
    Copyright (c) 2014-2024 PikeTec GmbH - MIT License (MIT) - All rights reserved
    See Also:
    Serialized Form

    • Constructor Detail

      • CodeBeamerRequirementsImportSettings

        public CodeBeamerRequirementsImportSettings()
        The contructor for the import settings of requirements from codeBeamer.

    • Method Detail

      • getProjectId

        public int getProjectId()
        Returns:
        The ID of the project if using a tracker (i.e., a simple query) for the import. Not relevant if using an advanced cbQL query.

      • setProjectId

        public void setProjectId​(int projectId)
        Parameters:
        projectId - The ID of the project if using a tracker (i.e., a simple query) for the import. Not relevant if using an advanced cbQL query.

      • getTrackerId

        public int getTrackerId()
        Returns:
        The ID of the tracker if using a simple query for the import. Not relevant if using an advanced cbQL query.

      • setTrackerId

        public void setTrackerId​(int trackerId)
        Parameters:
        trackerId - The ID of the tracker if using a simple query for the import. Not relevant if using an advanced cbQL query.

      • getSimpleBaselineId

        public int getSimpleBaselineId()
        Returns:
        The ID of the baseline if using a simple query for the import. Not relevant if using an advanced cbQL query.
        The HEAD baseline is represented by -1.

      • setSimpleBaselineId

        public void setSimpleBaselineId​(int simpleBaselineId)
        Parameters:
        simpleBaselineId - The ID of the baseline if using a simple query for the import. Not relevant if using an advanced cbQL query.
        The HEAD baseline is represented by -1.

      • getAdvancedBaselineId

        public int getAdvancedBaselineId()
        Returns:
        The ID of the baseline if using an advanced cbQL query for the import. Not relevant if using a simple query.
        The HEAD baseline is represented by -1.

      • setAdvancedBaselineId

        public void setAdvancedBaselineId​(int advancedBaselineId)
        Parameters:
        advancedBaselineId - The ID of the baseline if using an advanced cbQL query) for the import. Not relevant if using a simple query.
        The HEAD baseline is represented by -1.

      • getAdvancedQuery

        public java.lang.String getAdvancedQuery()
        Returns:
        The query using an advanced cbQL query) for the import. Not relevant if using a simple query.

      • setAdvancedQuery

        public void setAdvancedQuery​(java.lang.String advancedQuery)
        Parameters:
        advancedQuery - The query using an advanced cbQL query) for the import. Not relevant if using a simple query.

      • isUnescapeWikiText

        public boolean isUnescapeWikiText()
        Returns:
        Whether imported text from codeBeamer wiki text fields will be unescaped.

      • setUnescapeWikiText

        public void setUnescapeWikiText​(boolean unescapeWikiText)
        Parameters:
        unescapeWikiText - Whether imported text from codeBeamer wiki text fields will be unescaped.

      • getTypeAssignments

        public java.util.List<Pair<java.lang.String,​Requirement.RequirementType>> getTypeAssignments()
        Returns:
        The assignments of codeBeamer types (items in the codeBeamer field 'Types') to the requirement type in TPT. Items without an assigned TPT type are imported as Requirement.

      • setTypeAssignments

        public void setTypeAssignments​(java.util.List<Pair<java.lang.String,​Requirement.RequirementType>> typeAssignments)
        Parameters:
        typeAssignments - The assignments of codeBeamer types (items in the codeBeamer field 'Types') to the requirement type in TPT. Items without an assigned TPT type are imported as Requirement.

      • isImportLinksToTestCases

        public boolean isImportLinksToTestCases()
        Returns:
        Whether to import links to test cases, taking into account all downstream references that originate from test case trackers, reference the requirement in its subjects/verifies field and have already been imported to TPT. For performance reasons it is recommended not to import the links during requirements import, but during the test case import.

      • setImportLinksToTestCases

        public void setImportLinksToTestCases​(boolean importLinksToTestCases)
        Parameters:
        importLinksToTestCases - Whether to import links to test cases, taking into account all downstream references that originate from test case trackers, reference the requirement in its subjects/verifies field and have already been imported to TPT. For performance reasons it is recommended not to import the links during requirements import, but during the test case import.

      • getAttributeFields

        public java.util.List<java.lang.String> getAttributeFields()
        Returns:
        The List of codeBeamer field names to import their content as additional requirement attributes.

      • setAttributeFields

        public void setAttributeFields​(java.util.List<java.lang.String> attributeColumns)
        Parameters:
        attributeColumns - The List of codeBeamer field names to import their content as additional requirement attributes.