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

Class CodeBeamerTestCasesImportSettings

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

    • Constructor Detail

      • CodeBeamerTestCasesImportSettings

        public CodeBeamerTestCasesImportSettings()
        The contructor for the import settings of test cases 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.

      • isImportLinksToRequirements

        public boolean isImportLinksToRequirements()
        Returns:
        Whether to import links to requirements, taking into account all referenced items in the subjects/verifies field that originate from requirement trackers and have already been imported to TPT.

      • setImportLinksToRequirements

        public void setImportLinksToRequirements​(boolean importLinksToRequirements)
        Parameters:
        importLinksToRequirements - Whether to import links to requirements, taking into account all referenced items in the subjects/verifies field that originate from requirement trackers and have already been imported to TPT.

      • getStatusTypeAssignments

        public java.util.List<CodeBeamerStatusAssignment> getStatusTypeAssignments()
        Returns:
        The assigments of TPT status types to codeBeamer status options.

      • setStatusTypeAssignments

        public void setStatusTypeAssignments​(java.util.List<CodeBeamerStatusAssignment> statusTypeAssignments)
        Parameters:
        statusTypeAssignments - The assigments of TPT status types to codeBeamer status options.

      • getAttributeAssignments

        public java.util.List<CodeBeamerFieldAssignment> getAttributeAssignments()
        Returns:
        The list of codeBeamer fields to be imported as test case attributes.

      • setAttributeAssignments

        public void setAttributeAssignments​(java.util.List<CodeBeamerFieldAssignment> attributeAssignments)
        Parameters:
        attributeAssignments - The list of codeBeamer fields to be imported as test case attributes.

      • isImportTestStepsAsDocSteps

        public boolean isImportTestStepsAsDocSteps()
        Returns:
        Whether to import test steps as documentation steps into step lists. Existing documentation steps are matched via the index ('#<index>' in the begin of the documenation step) and are overriden. If no matching documentation step is found a new one will be added to the end of the step list.

      • setImportTestStepsAsDocSteps

        public void setImportTestStepsAsDocSteps​(boolean importTestStepsAsDocSteps)
        Parameters:
        importTestStepsAsDocSteps - Whether to import test steps as documentation steps into step lists. Existing documentation steps are matched via the index ('#<index>' in the begin of the documenation step) and are overriden. If no matching documentation step is found a new one will be added to the end of the step list.

      • isImportItemUrlAsAttribute

        public boolean isImportItemUrlAsAttribute()
        Returns:
        Whether the URL of each tracker item will be imported into a test case attribute.

      • setImportItemUrlAsAttribute

        public void setImportItemUrlAsAttribute​(boolean importItemUrlAsAttribute)
        Parameters:
        importItemUrlAsAttribute - Whether the URL of each tracker item will be imported into a test case attribute.

      • getUrlAttribute

        public java.lang.String getUrlAttribute()
        Returns:
        The name of the test case attribute to store the URL of each tracker item if isImportItemUrlAsAttribute() is true (not relevant if it is false).

      • setUrlAttribute

        public void setUrlAttribute​(java.lang.String urlAttribute)
        Parameters:
        urlAttribute - The name of the test case attribute to store the URL of each tracker item if isImportItemUrlAsAttribute() is true (not relevant if it is false).