Package com.piketec.tpt.api

Interface AdvancedReportSettings

  • All Superinterfaces:
    IdentifiableRemote, java.rmi.Remote, TptRemote
    public interface AdvancedReportSettings
extends IdentifiableRemote
    General configuration of the report created after a test run.
    Author:
    Copyright (c) 2014-2020 Piketec GmbH - MIT License (MIT) - All rights reserved

    • Method Detail

      • addAdditionalRequirementAttr

        void addAdditionalRequirementAttr​(java.lang.String attr)
                           throws java.rmi.RemoteException
        Adds an additional attribute for the requirements result tables.
        Parameters:
        attr - the name of requirements attribute (column) to add to the report
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getAdditionalRequirementAttrs

        RemoteList<java.lang.String> getAdditionalRequirementAttrs()
                                                    throws java.rmi.RemoteException
        Gets all additional attributes for the requirements result tables.
        Returns:
        get attribute additionalRequirementAttrs
        Throws:
        java.rmi.RemoteException - remote communication problem

      • addTestcasetAttr

        void addTestcasetAttr​(java.lang.String attr)
               throws java.rmi.RemoteException
        Adds an attribute of the testcase to the testcase summary table.
        Parameters:
        attr - the name of the test case attribute to add to the report
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getTestcaseAttrs

        RemoteList<java.lang.String> getTestcaseAttrs()
                                       throws java.rmi.RemoteException
        Gets all attributes that are shown for each testcase in the testcase summary table.
        Returns:
        get testcase attributes
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getAssessmentVariableFilter

        java.lang.String getAssessmentVariableFilter()
                                      throws java.rmi.RemoteException
        Get attribute assessmentVariableFilter. In case of a huge amount of assessment variables it might be useful to limit the maximum number of assessment variables shown in the report. This can be done by specifying a regular expression pattern in setAssessmentVariableFilter(String). Only if the pattern matches an assessment variable name, the variable is shown in the report. For easier distinction use getShowAssessmentVariables()
        Returns:
        get attribute assessmentVariableFilter, which is a regular expression pattern
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getOverviewImagePath

        java.lang.String getOverviewImagePath()
                               throws java.rmi.RemoteException
        Get attribute OverviewImagePath. This image will be shown at the beginning of the report.
        Returns:
        get attribute OverviewImagePath
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getOverviewText

        java.lang.String getOverviewText()
                          throws java.rmi.RemoteException
        Get attribute OverviewText. This text is shown at the beginning of the report.
        Returns:
        get attribute OverviewText
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getCompressionPath

        java.lang.String getCompressionPath()
                             throws java.rmi.RemoteException
        Get target path for the compressed report file.
        Returns:
        get attribute compressionPath
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getShowAssessmentVariables

        AdvancedReportSettings.ShowAssessmentVariables getShowAssessmentVariables()
                                                                   throws java.rmi.RemoteException
        Get attribute showAssessmentVariables. An assessment variable is a variable used for evaluating tests. It contains data structures that relate the values of a variable to time intervals. Use this variable to specify whether and how to display assessment variables in the report.
        Returns:
        get attribute AdvancedReportSettings.ShowAssessmentVariables:
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isOverviewBuildAutomatically

        boolean isOverviewBuildAutomatically()
                              throws java.rmi.RemoteException
        Get attribute buildOverviewAutomatically. Set to true to finalize the test run and generate the report overview automatically when the last test has been executed.
        Returns:
        get attribute buildOverviewAutomatically
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isOnlyLinkedRequirements

        boolean isOnlyLinkedRequirements()
                          throws java.rmi.RemoteException
        Check only Requirements linked to the executed test case or variant: The overall result of a requirement is derived from all partial results accumulated during the test execution. Optionally you can restrict them to consider only results achieved while running linked test cases or variants by setting this boolean to true.
        Returns:
        get attribute considerOnlyLinkedRequirements
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isCreateRequirementsOverviewSection

        boolean isCreateRequirementsOverviewSection()
                                     throws java.rmi.RemoteException
        Determines if a requirements overview section is generated.
        Returns:
        get attribute createRequirementsOverview
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isDeleteReportDirAfterCompression

        boolean isDeleteReportDirAfterCompression()
                                   throws java.rmi.RemoteException
        Determines if the report directory is deleted after writing the compressed report file. If and only if the compressed report file isn't somewhere within the report directory.
        Returns:
        get attribute deleteReportDirAfterCompression
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isDeriveRequirementResultsFromTCIfNotCheckedInAnyAssesslets

        boolean isDeriveRequirementResultsFromTCIfNotCheckedInAnyAssesslets()
                                                             throws java.rmi.RemoteException
        If this flag is set and a requirement was not checked in any assesslet (REQUIREMENTS.checked()), its result is set to the test case result.
        Returns:
        get attribute deriveRequirementResultsFromTCIfNotChecked
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isGenerateRequirementsAssessletResultsTable

        boolean isGenerateRequirementsAssessletResultsTable()
                                             throws java.rmi.RemoteException
        Determines if a requirements assesslet results table section is written in the requirements overview section, which shows which Requirement has been checked by what Assesslets and with what result.
        Returns:
        get attribute generateRequirementsAssessletResultsTable
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isGenerateVariableSummary

        boolean isGenerateVariableSummary()
                           throws java.rmi.RemoteException
        Determines if a variable summary section is generated.
        Returns:
        get attribute generateVariableSummary
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isGenerateStatusSummary

        boolean isGenerateStatusSummary()
                         throws java.rmi.RemoteException
        Determines if "Status Summary" report page is generated.
        Returns:
        get attribute generateStatusSummary
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isIncludeSignalViewerApplet

        boolean isIncludeSignalViewerApplet()
                             throws java.rmi.RemoteException
        Determines if Signal-Viewer-Links are included.
        Returns:
        get attribute includeSignalViewerApplet
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isCompressReport

        boolean isCompressReport()
                  throws java.rmi.RemoteException
        Determines if a compressed file is generated. If set to true but no file is set, an Exception is thrown. The path can be set with setCompressionPath(String).
        Returns:
        get attribute packReport
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isPackCustomFilter

        boolean isPackCustomFilter()
                    throws java.rmi.RemoteException
        Returns:
        Determines if custom filter settings (getCustomPackExcludeFilter() and getCustomPackIncludeFilter()) will be used to determine the content of the report archive.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isPackTestReportData

        boolean isPackTestReportData()
                      throws java.rmi.RemoteException
        Returns:
        Determines if test report files will be archived in the report archive.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isPackTestSummaryData

        boolean isPackTestSummaryData()
                       throws java.rmi.RemoteException
        Returns:
        Determines if test summary files will be archived in the report archive.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isPackTestRecordData

        boolean isPackTestRecordData()
                      throws java.rmi.RemoteException
        Returns:
        Determines if test record files will be archived in the report archive.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getCustomPackIncludeFilter

        java.lang.String getCustomPackIncludeFilter()
                                     throws java.rmi.RemoteException
        Returns:
        Returns the custom include filter string. Please see UI documentation for detailed information.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getCustomPackExcludeFilter

        java.lang.String getCustomPackExcludeFilter()
                                     throws java.rmi.RemoteException
        Returns:
        Returns the custom exclude filter string. Please see UI documentation for detailed information.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isShowPlatformOverviewComment

        boolean isShowPlatformOverviewComment()
                               throws java.rmi.RemoteException
        Determines if a comment column is generated for the Test Case Summary table in the Platform Overview section.
        Returns:
        get attribute platformOverviewComment
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isShowPlatformOverviewDirectory

        boolean isShowPlatformOverviewDirectory()
                                 throws java.rmi.RemoteException
        Determines if a directory column is generated for the Test Case Summary table in the Platform Overview section.
        Returns:
        get attribute platformOverviewDirectory
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isShowRequirementHeadings

        boolean isShowRequirementHeadings()
                           throws java.rmi.RemoteException
        When importing requirements, there might be requirements tagged as heading (for more detail see requirements import configure import types). They can not be linked to any test cases and are there for structural reasons. If set to false, they are not shown in the report (which might make it a bit smaller).
        Returns:
        get attribute showRequirementHeadings
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isShowRequirementInformation

        boolean isShowRequirementInformation()
                              throws java.rmi.RemoteException
        When importing requirements, there might be requirements tagged as information (for more detail see requirements Import Configure import types). They can not be linked to any test cases and are there for structural reasons. If set to false, they are not shown in the report (which might make it a bit smaller).
        Returns:
        get attribute showInformation
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isShowRequirementComments

        boolean isShowRequirementComments()
                           throws java.rmi.RemoteException
        Determines if comments in the requirements results table are displayed.
        Returns:
        get attribute showRequirementComments
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isShowDocumentVersions

        boolean isShowDocumentVersions()
                        throws java.rmi.RemoteException
        Determines if document versions in the requirements results table are displayed.
        Returns:
        get attribute showDocumentVersions
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isCheckAndShowTestCaseStatusInformation

        boolean isCheckAndShowTestCaseStatusInformation()
                                         throws java.rmi.RemoteException
        Get attribute checkAndShowTestCaseStatusInformation. If this is set to true, an overview table is added to the report, showing all test cases with their status (e.g. stable, in progress, new, ...)
        Returns:
        get attribute checkAndShowTestCaseStatusInformation
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isCheckAndShowAssessmentStatusInformation

        boolean isCheckAndShowAssessmentStatusInformation()
                                           throws java.rmi.RemoteException
        Get attribute checkAndShowAssessmentStatusInformation. If this is set to true, an overview table is added to the report, showing all assessments with their status (e.g. stable, in progress, new, ...)
        Returns:
        get attribute checkAndShowAssessmentStatusInformation
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setAssessmentVariableFilter

        void setAssessmentVariableFilter​(java.lang.String assessmentVariableFilter)
                          throws java.rmi.RemoteException
        Change attribute assessmentVariableFilter. In case of a huge amount of assessment variables it might be useful to limit the maximum number of assessment variables shown in the report. This can be done by specifying a regular expression pattern in the Pattern TextField. Only if the pattern matches an assessment variable name, the variable is shown in the report. For easier distinction use setShowAssessmentVariables()
        Parameters:
        assessmentVariableFilter - the new attribute value: a regular expression pattern
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setOverviewBuildAutomatically

        void setOverviewBuildAutomatically​(boolean buildReportAutomatically)
                            throws java.rmi.RemoteException
        Change attribute buildOverviewAutomatically. Set to true to finalize the test run and generate the report overview automatically when the last test has been executed.
        Parameters:
        buildReportAutomatically - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setOnlyLinkedRequirements

        void setOnlyLinkedRequirements​(boolean considerOnlyLinkedRequirements)
                        throws java.rmi.RemoteException
        Set if only linked Requirements are printed into the report.
        Parameters:
        considerOnlyLinkedRequirements - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setCreateRequirementsOverviewSection

        void setCreateRequirementsOverviewSection​(boolean createRequirementsOverview)
                                   throws java.rmi.RemoteException
        Set if an requirement overview section is created.
        Parameters:
        createRequirementsOverview - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setDeleteReportDirAfterCompression

        void setDeleteReportDirAfterCompression​(boolean deleteReportDirAfterCompression)
                                 throws java.rmi.RemoteException
        Set if the report-directory is deleted after generating the compressed report file. If and only if the compressed report file isn't somewhere within the report directory.
        Parameters:
        deleteReportDirAfterCompression - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setDeriveRequirementResultsFromTCIfNotCheckedInAnyAssesslets

        void setDeriveRequirementResultsFromTCIfNotCheckedInAnyAssesslets​(boolean deriveRequirementResultsFromTCIfNotChecked)
                                                           throws java.rmi.RemoteException
        If this flag is set and a requirement was not checked in any assesslet (REQUIREMENTS.checked()), its result is set to the test case result.
        Parameters:
        deriveRequirementResultsFromTCIfNotChecked - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setOverviewImagePath

        void setOverviewImagePath​(java.lang.String overviewImagePath)
                   throws java.rmi.RemoteException
        Change attribute OverviewImagePath. This image will be shown at the beginning of the report.
        Parameters:
        overviewImagePath - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setOverviewText

        void setOverviewText​(java.lang.String overviewText)
              throws java.rmi.RemoteException
        Change attribute overviewText. This text is shown at the beginning of the report.
        Parameters:
        overviewText - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setGenerateRequirementsAssessletResultsTable

        void setGenerateRequirementsAssessletResultsTable​(boolean generateRequirementsAssessletResultsTable)
                                           throws java.rmi.RemoteException
        Changes if a requirements assesslet results table section is generated, which shows which Requirements have been checked by what Assesslets and with what result.
        Parameters:
        generateRequirementsAssessletResultsTable - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setGenerateVariableSummary

        void setGenerateVariableSummary​(boolean generateVariableSummary)
                         throws java.rmi.RemoteException
        Changes if a Variables Summary section is generated.
        Parameters:
        generateVariableSummary - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setGenerateStatusSummary

        void setGenerateStatusSummary​(boolean generateStatusSummary)
                       throws java.rmi.RemoteException
        Changes if "Status Summary" report page is generated.
        Parameters:
        generateStatusSummary - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setIncludeSignalViewerApplet

        void setIncludeSignalViewerApplet​(boolean includeSignalViewerApplet)
                           throws java.rmi.RemoteException
        Changes if Signal-Viewer-Links are included.
        Parameters:
        includeSignalViewerApplet - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setCompressReport

        void setCompressReport​(boolean packReport)
                throws java.rmi.RemoteException
        Changes if a compressed report file is generated.
        Parameters:
        packReport - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setPackCustomFilter

        void setPackCustomFilter​(boolean customFilter)
                  throws java.rmi.RemoteException
        Changes if custom include and exclude filters are applied for compressed report.
        Parameters:
        customFilter - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setPackTestReportData

        void setPackTestReportData​(boolean packReportData)
                    throws java.rmi.RemoteException
        Changes if the compressed report includes test report files.
        Parameters:
        packReportData - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setPackTestSummaryData

        void setPackTestSummaryData​(boolean packSummaryData)
                     throws java.rmi.RemoteException
        Changes if the compressed report includes summary (e.g. xml) files.
        Parameters:
        packSummaryData - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setPackTestRecordData

        void setPackTestRecordData​(boolean packRecordData)
                    throws java.rmi.RemoteException
        Changes if the compressed report includes test record (e.g. tptbin) files.
        Parameters:
        packRecordData - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setCustomPackIncludeFilter

        void setCustomPackIncludeFilter​(java.lang.String includeFilter)
                         throws java.rmi.RemoteException
        Sets a custom include filter string. Please see UI documentation for detailed information.
        Parameters:
        includeFilter - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setCustomPackExcludeFilter

        void setCustomPackExcludeFilter​(java.lang.String excludeFilter)
                         throws java.rmi.RemoteException
        Sets a custom exclude filter string. Please see UI documentation for detailed information.
        Parameters:
        excludeFilter - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setShowPlatformOverviewComment

        void setShowPlatformOverviewComment​(boolean platformOverviewComment)
                             throws java.rmi.RemoteException
        Changes if a comment column is generated for the Test Case Summary table in the Platform Overview section.
        Parameters:
        platformOverviewComment - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setShowPlatformOverviewDirectory

        void setShowPlatformOverviewDirectory​(boolean platformOverviewDirectory)
                               throws java.rmi.RemoteException
        Changes if a directory column is generated for the Test Case Summary table in the Platform Overview section.
        Parameters:
        platformOverviewDirectory - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setCompressionPath

        void setCompressionPath​(java.lang.String compressionPath)
                 throws java.rmi.RemoteException
        Changes the target path of the compressed report file. If the given path has no file extension, a .zip is added to the path.
        Parameters:
        compressionPath - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setShowAssessmentVariables

        void setShowAssessmentVariables​(AdvancedReportSettings.ShowAssessmentVariables showAssessmentVariables)
                         throws java.rmi.RemoteException
        Change attribute showAssessmentVariables. An assessment variable is a variable used for evaluating tests. It contains data structures that relate the values of a variable to time intervals. Use this variable to specify whether and how to display assessment variables in the report.
        Parameters:
        showAssessmentVariables - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setShowRequirementHeadings

        void setShowRequirementHeadings​(boolean showHeadings)
                         throws java.rmi.RemoteException
        When importing requirements, there might be requirements tagged as heading (for more detail see requirements import configure import types). They can not be linked to any test cases and are there for structural reasons. If set to false, they are not shown in the report (which might make it a bit smaller).
        Parameters:
        showHeadings - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setShowRequirementInformation

        void setShowRequirementInformation​(boolean showInformation)
                            throws java.rmi.RemoteException
        When importing requirements, there might be requirements tagged as information (for more detail see requirements import configure import types). They can not be linked to any test cases and are there for structural reasons. If set to false, they are not shown in the report (which might make it a bit smaller).
        Parameters:
        showInformation - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setShowRequirementComments

        void setShowRequirementComments​(boolean showRequirementComments)
                         throws java.rmi.RemoteException
        Changes if comments are shown in the requirements results table.
        Parameters:
        showRequirementComments - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setShowDocumentVersions

        void setShowDocumentVersions​(boolean showDocumentVersions)
                      throws java.rmi.RemoteException
        Changes if document versions are shown in the requirements results table.
        Parameters:
        showDocumentVersions - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setCheckAndShowTestCaseStatusInformation

        void setCheckAndShowTestCaseStatusInformation​(boolean checkAndShowTestCaseStatusInformation)
                                       throws java.rmi.RemoteException
        If this is set to true, an overview table is added to the report, showing all test cases with their status (e.g. stable, in progress, new, ...)
        Parameters:
        checkAndShowTestCaseStatusInformation - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setCheckAndShowAssessmentStatusInformation

        void setCheckAndShowAssessmentStatusInformation​(boolean checkAndShowAssessmentStatusInformation)
                                         throws java.rmi.RemoteException
        If this is set to true, an overview table is added to the report, showing all assessments with their status (e.g. stable, in progress, new, ...)
        Parameters:
        checkAndShowAssessmentStatusInformation - the new attribute value
        Throws:
        java.rmi.RemoteException - remote communication problem