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

Class CodeBeamerTestCasesExportSettings

  • All Implemented Interfaces:
    java.io.Serializable
    public class CodeBeamerTestCasesExportSettings
extends TestCasesExportSettings
    The settings for the export of test cases to codeBeamer.
    Author:
    Copyright (c) 2014-2024 PikeTec GmbH - MIT License (MIT) - All rights reserved
    See Also:
    Serialized Form

    • Constructor Detail

      • CodeBeamerTestCasesExportSettings

        public CodeBeamerTestCasesExportSettings()
        The constructor for the export settings of test cases to codeBeamer.

    • Method Detail

      • getTestset

        public java.lang.String getTestset()
        Returns:
        testset The 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 test set to export a subset of TPT test cases. If null, all test cases are exported.

      • getAttributeWithCodeBeamerIDs

        public java.lang.String getAttributeWithCodeBeamerIDs()
        Returns:
        The TPT test case attribute which contains the codeBeamer IDs. It will be used to update test cases which already are known in codeBeamer. Furthermore the IDs of newly created work items will be applied to the respective TPT test cases.

      • setAttributeWithCodeBeamerIDs

        public void setAttributeWithCodeBeamerIDs​(java.lang.String attributeWithCodeBeamerIDs)
        Parameters:
        attributeWithCodeBeamerIDs - The TPT test case attribute which contains the codeBeamer IDs. It will be used to update test cases which already are known in codeBeamer. Furthermore the IDs of newly created work items will be applied to the respective TPT test cases.

      • isExportHierarchy

        public boolean isExportHierarchy()
        Returns:
        true, if the hierarchy of test cases is exported. false, if all test cases are exported as a flat list.

      • setExportHierarchy

        public void setExportHierarchy​(boolean exportHierarchy)
        Parameters:
        exportHierarchy - If true, the hierarchy of test cases is exported. If false, all test cases are exported as a flat list.

      • isExportLinksToRequirements

        public boolean isExportLinksToRequirements()
        Returns:
        If true, the links from test cases to requirements are exported to codeBeamer. Existing links in codeBeamer are overwritten.
        If false, the links from test case to requirements are not exported. Existing links in codeBeamer remain untouched.

      • setExportLinksToRequirements

        public void setExportLinksToRequirements​(boolean exportLinksToRequirements)
        Parameters:
        exportLinksToRequirements - If true, the links from test cases to requirements are exported to codeBeamer. Existing links in codeBeamer are overwritten.
        If false, the links from test case to requirements are not exported. Existing links in codeBeamer remain untouched.

      • isExportResults

        public boolean isExportResults()
        Returns:
        If true, last known results are exported.

      • setExportResults

        public void setExportResults​(boolean exportResults)
        Parameters:
        exportResults - If set to true, last known results are exported. A test run tracker must be selected in this case.
        See Also:
        setTestRunTrackerId(int)

      • getAttributeAssignments

        public java.util.List<CodeBeamerFieldAssignment> getAttributeAssignments()
        Returns:
        the list of assignments of a codeBeamer field to a test case attribute.

      • setAttributeAssignments

        public void setAttributeAssignments​(java.util.List<CodeBeamerFieldAssignment> attributeAssignments)
        Parameters:
        attributeAssignments - the list of assignments of a codeBeamer field to a test case attribute.

      • getTptIdField

        public java.lang.String getTptIdField()
        Returns:
        The name of a codeBeamer field (of type integer or text) to which the TPT test case IDs will be written. If null, TPT test case IDs are not exported.
        Some TPT projects use prefixed test case IDs, which cannot be written to integer fields in codeBeamer. Use a text field in this case.

      • setTptIdField

        public void setTptIdField​(java.lang.String tptIdField)
        Parameters:
        tptIdField - The name of a codeBeamer field (of type integer or text) to which the TPT test case IDs will be written. If null, TPT test case IDs are not exported.
        Some TPT projects use prefixed test case IDs, which cannot be written to integer fields in codeBeamer. Use a text field in this case.

      • getProjectId

        public int getProjectId()
        Returns:
        The ID of the project in codeBeamer.

      • setProjectId

        public void setProjectId​(int projectId)
        Parameters:
        projectId - The ID of the project in codeBeamer.

      • getTrackerId

        public int getTrackerId()
        Returns:
        The ID of the tracker from the project in codeBeamer. The test cases are exported into this tracker.

      • setTrackerId

        public void setTrackerId​(int trackerId)
        Parameters:
        trackerId - The ID of the tracker from the project in codeBeamer. The test cases are exported into this tracker.

      • getTestRunTrackerId

        public int getTestRunTrackerId()
        Returns:
        The test run tracker from codeBeamer to which the test results are exported (if enabled).
        See Also:
        setExportResults(boolean)

      • setTestRunTrackerId

        public void setTestRunTrackerId​(int testRunTrackerId)
        Parameters:
        testRunTrackerId - The test run tracker from codeBeamer to which the test results are exported (if enabled).
        See Also:
        setExportResults(boolean)

      • isExportDocStepsAsTestSteps

        public boolean isExportDocStepsAsTestSteps()
        Returns:
        Whether the documentation steps are exported as test steps to codeBeamer. If true, existing test steps in codeBeamer are overwritten. If the test step table has more than the three standard columns (Critical, Action and Expected Result), data in the other columns can be lost. This is only applied to step lists and documentation steps that have the correct syntax. The syntax looks as follows: #<index> <!>(if critical) <action> : <expected result>.

      • setExportDocStepsAsTestSteps

        public void setExportDocStepsAsTestSteps​(boolean exportDocStepsAsTestSteps)
        Parameters:
        exportDocStepsAsTestSteps - If set to true, the documentation steps are exported as test steps to codeBeamer (existing test steps in codeBeamer are overwritten). If the test step table has more than the three standard columns (Critical, Action and Expected Result), data in the other columns can be lost. This is only applied to step lists and documentation steps that have the correct syntax. The syntax looks as follows: #<index> <!>(if critical) <action> : <expected result>.

      • isDeleteUnknownItems

        public boolean isDeleteUnknownItems()
        Returns:
        Whether unknown tracker items in codeBeamer, i.e. items that are not exported during this export, will be moved to trash.

      • setDeleteUnknownItems

        public void setDeleteUnknownItems​(boolean deleteUnknownItems)
        Parameters:
        deleteUnknownItems - If set to true, unknown tracker items in codeBeamer, i.e. items that are not exported during this export, will be moved to trash.