Package com.piketec.tpt.api.requirements.polarion

Class PolarionTestCasesImportSettings

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

    • Constructor Detail

      • PolarionTestCasesImportSettings

        public PolarionTestCasesImportSettings​(java.lang.String projectId)
        The constructor for the settings of the test cases import from Polarion.
        Parameters:
        projectId - The ID of the project in Polarion.

    • Method Detail

      • getProjectId

        public java.lang.String getProjectId()
        Returns:
        The ID of the project in Polarion.

      • setProjectId

        public void setProjectId​(java.lang.String projectId)
        Parameters:
        projectId - The ID of the project in Polarion.

      • setImportMethod

        public void setImportMethod​(PolarionTestCasesImportSettings.PolarionImportMethod importMethod)
        Parameters:
        importMethod - The choice for the import. Either import via Document by using the path to the document followed by its ID (e.g., Testing/Test Specification), or import via Lucene by using a query in Lucene syntax.

      • getDocumentPath

        public java.lang.String getDocumentPath()
        Returns:
        The path to the document followed by its ID (e.g., Testing/Test Specification). Only relevant if import method is Document.
        See Also:
        setImportMethod(PolarionImportMethod)

      • setDocumentPath

        public void setDocumentPath​(java.lang.String documentPath)
        Parameters:
        documentPath - The path to the document followed by its ID (e.g., Testing/Test Specification). Only relevant if import method is Document.
        See Also:
        setImportMethod(PolarionImportMethod)

      • getLuceneQuery

        public java.lang.String getLuceneQuery()
        Returns:
        If null, all work items of the project are imported. Otherwise a query in Lucene syntax to import a subset of the project work items (e.g., type:testcase). Only relevant if import method is Lucene.
        See Also:
        setImportMethod(PolarionImportMethod)

      • setLuceneQuery

        public void setLuceneQuery​(java.lang.String luceneQuery)
        Parameters:
        luceneQuery - If set to null, all work items of the project are imported. Otherwise set to a query in Lucene syntax to import a subset of the project work items (e.g., type:testcase). Only relevant if import method is Lucene.
        See Also:
        setImportMethod(PolarionImportMethod)

      • isImportDescription

        public boolean isImportDescription()
        Returns:
        Whether to import the Polarion description to the test case description in TPT. Note that the description will be imported as plain text.

      • setImportDescription

        public void setImportDescription​(boolean importDescription)
        Parameters:
        importDescription - Whether to import the Polarion description to the test case description in TPT. Note that the description will be imported as plain text.

      • getTypeAssignments

        public java.util.List<TestCasesImportSettings.TargetTypeAssignment> getTypeAssignments()
        Returns:
        The list of assignments of the name of an imported object type to the TPT type (test case vs. test case group).

      • setTypeAssignments

        public void setTypeAssignments​(java.util.List<TestCasesImportSettings.TargetTypeAssignment> typeAssignments)
        Parameters:
        typeAssignments - The list of assignments of the name of an imported object type to the TPT type (test case vs. test case group).

      • setPropertyAssignments

        public void setPropertyAssignments​(java.util.List<PolarionWorkItemFieldToTCAttributeAssignment> propertyAssignments)
        Parameters:
        propertyAssignments - The list of assignments of Polarion Work Item fields to a TPT test case attributes.

      • getLinkRoles

        public java.util.List<java.lang.String> getLinkRoles()
        Returns:
        The list of Polarion Work Item field IDs that are links. If no link is chosen, no links will be imported and the respective links in TPT will remain untouched.
        See Also:
        setBackLinkRoles(List)

      • setLinkRoles

        public void setLinkRoles​(java.util.List<java.lang.String> linkRoles)
        Parameters:
        linkRoles - The list of Polarion Work Item field IDs that are links. If no link and no backlink is chosen, no links will be imported and the respective links in TPT will remain untouched.
        See Also:
        setBackLinkRoles(List)

      • getBackLinkRoles

        public java.util.List<java.lang.String> getBackLinkRoles()
        Returns:
        The list of Polarion Work Item field IDs that are backlinks. If no backlink and no link is chosen, no links will be imported and the respective links in TPT will remain untouched.
        See Also:
        setLinkRoles(List)

      • setBackLinkRoles

        public void setBackLinkRoles​(java.util.List<java.lang.String> backLinkRoles)
        Parameters:
        backLinkRoles - The list of Polarion Work Item field IDs that are backlinks. If no backlink and no link is chosen, no links will be imported and the respective links in TPT will remain untouched.
        See Also:
        setLinkRoles(List)