Package com.piketec.tpt.api

Interface ExecutionConfiguration

    • Method Detail

      • createExecutionConfigurationItem

        ExecutionConfigurationItem createExecutionConfigurationItem()
                                                     throws java.rmi.RemoteException
        Creates a new ExecutionConfigurationItem and adds it to the tail of the ExecutionConfiguration list. This list is represented by the table in the GUI.
        Returns:
        A fresh ExecutionConfigurationItem
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getDataDir

        @Deprecated
java.io.File getDataDir()
                 throws java.rmi.RemoteException
        Deprecated.
        No support for $-variables and relative paths - use getDataDirPath() instead. Will be removed in TPT-18.
        Returns:
        The data directory.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getDataDirPath

        java.lang.String getDataDirPath()
                         throws java.rmi.RemoteException
        Returns:
        Returns the test data directory as String
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getAdvancedReportSettings

        AdvancedReportSettings getAdvancedReportSettings()
                                          throws java.rmi.RemoteException
        Returns:
        Returns the advanced report settings.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getReportDir

        @Deprecated
java.io.File getReportDir()
                   throws java.rmi.RemoteException
        Deprecated.
        No support for $-variables and relative paths - use getReportDirPath() instead. Will be removed in TPT-18.
        Returns:
        The report directory.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getReportDirPath

        java.lang.String getReportDirPath()
                           throws java.rmi.RemoteException
        Returns:
        Returns the report directory.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getReferenceDirPath

        java.lang.String getReferenceDirPath()
                              throws java.rmi.RemoteException
        Returns:
        Returns the reference directory.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setDataDir

        @Deprecated
void setDataDir​(java.io.File f)
         throws java.rmi.RemoteException
        Deprecated.
        No support for $-variables and relative paths - use setDataDirPath(String) instead. Will be removed in TPT-18.
        Set the data directory.
        Parameters:
        f - The Data directory as File.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setDataDirPath

        void setDataDirPath​(java.lang.String path)
             throws java.rmi.RemoteException
        Set the data directory.
        Parameters:
        path - A directory as String.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setReportDir

        @Deprecated
void setReportDir​(java.io.File f)
           throws java.rmi.RemoteException
        Deprecated.
        No support for $-variables and relative paths - use setReportDirPath(String) instead. Will be removed in TPT-18.
        Set the report directory.

        Optionally, specify the report directory as File. Use null to set the data directory.

        Parameters:
        f - The report directory as File or null
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setReferenceDirPath

        void setReferenceDirPath​(java.lang.String path)
                  throws java.rmi.RemoteException
        Set the reference directory.
        Parameters:
        path - A directory as String.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setReportDirPath

        void setReportDirPath​(java.lang.String path)
               throws java.rmi.RemoteException
        Set the report directory.

        Optionally, specify the report directory as String. Use null to set the data directory.

        Parameters:
        path - The report directory as String or null
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isRunExec

        boolean isRunExec()
           throws java.rmi.RemoteException
        Returns:
        Returns true if test should be executed. Represents the "Execute" check box.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isRunAssess

        boolean isRunAssess()
             throws java.rmi.RemoteException
        Returns:
        Returns true if the assessments should be executed. Represents the "Assess" check box.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isRunReport

        boolean isRunReport()
             throws java.rmi.RemoteException
        Returns:
        Returns true if a report should be generated. Represents the "Report" check box.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isRunDashboard

        boolean isRunDashboard()
                throws java.rmi.RemoteException
        Returns:
        Returns true if the dashboard should be enabled during test execution. Represent the "Dashboard" check box.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setRunExec

        void setRunExec​(boolean enabled)
         throws java.rmi.RemoteException
        Parameters:
        enabled - Set whether tests should be executed.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setRunAssess

        void setRunAssess​(boolean enabled)
           throws java.rmi.RemoteException
        Parameters:
        enabled - Set whether assessments should be executed.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setRunReport

        void setRunReport​(boolean enabled)
           throws java.rmi.RemoteException
        Parameters:
        enabled - Set whether a report should be generated.

        Note that a report can be only generated if assessments have been executed.

        Throws:
        java.rmi.RemoteException - remote communication problem

      • setRunDashboard

        void setRunDashboard​(boolean enabled)
              throws java.rmi.RemoteException
        Parameters:
        enabled - Enable the dashboard during execution.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getAttributes

        @Deprecated
java.util.Map<java.lang.String,​java.lang.String> getAttributes()
                                                              throws java.rmi.RemoteException
        Deprecated.
        Please use getAttributesList() instead
        Returns the additional attributes for a Execution Configuration as specified by the user. This map corresponds to the "Attributes" tab of the Execution Configuration GUI.
        Returns:
        User attributes as map
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setAttributes

        @Deprecated
void setAttributes​(java.lang.String key,
                   java.lang.String value)
            throws ApiException,
                   java.rmi.RemoteException
        Deprecated.
        Please use setAttributesList(List) instead. Will be removed in TPT-18.
        Set a user-defined attribute given by key to the value given by the value parameter. If value==null, the attribute key will be deleted.
        Parameters:
        key - The name of the attribute to be set.
        value - The new value or null to delete the attribute.
        Throws:
        ApiException - if key==null
        java.rmi.RemoteException - remote communication problem

      • getAttributesList

        java.util.List<Pair<java.lang.String,​java.lang.String>> getAttributesList()
                                                                         throws java.rmi.RemoteException
        Returns the additional attributes for a Execution Configuration as specified by the user. This list corresponds to the "Attributes" tab of the Execution Configuration GUI.
        Returns:
        User attributes as list.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setAttributesList

        void setAttributesList​(java.util.List<Pair<java.lang.String,​java.lang.String>> attributes)
                throws ApiException,
                       java.rmi.RemoteException
        Set a list of user-defined attributes given by pair.first to the value given by the pair.second parameter.
        Parameters:
        attributes - user-defined attribute list
        Throws:
        ApiException - if attributes==null || pair.second == null || pair.first==null || pair.first.contains("\n")
        java.rmi.RemoteException - remote communication problem

      • getReportFormat

        ExecutionConfiguration.ReportFormat getReportFormat()
                                             throws ApiException,
                                                    java.rmi.RemoteException
        Returns:
        The currently selected report format
        Throws:
        ApiException - If the currently selected report format is unknown.
        java.rmi.RemoteException - remote communication problem

      • setReportFormat

        void setReportFormat​(ExecutionConfiguration.ReportFormat rf)
              throws ApiException,
                     java.rmi.RemoteException
        Set the report format.
        Parameters:
        rf - the new report format.
        Throws:
        ApiException - If the given report format is not known to the API.
        java.rmi.RemoteException - remote communication problem

      • getReferenceDirMode

        ExecutionConfiguration.ReferenceMode getReferenceDirMode()
                                                  throws ApiException,
                                                         java.rmi.RemoteException
        Returns:
        The currently selected reference mode.
        Throws:
        ApiException - If the currently selected report format is unknown.
        java.rmi.RemoteException - remote communication problem

      • setReferenceDirMode

        void setReferenceDirMode​(ExecutionConfiguration.ReferenceMode mode)
                  throws ApiException,
                         java.rmi.RemoteException
        Set the currently selected reference mode.
        Parameters:
        mode - the new reference mode.
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - If the given report format is not known to the API.

      • getDataDirStructure

        ExecutionConfiguration.DataDirStructure getDataDirStructure()
                                                     throws ApiException,
                                                            java.rmi.RemoteException
        Returns:
        the currently selected directory structure for saving the test data.
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - if the directory structure is unknown

      • setDataDirStructure

        void setDataDirStructure​(ExecutionConfiguration.DataDirStructure dds)
                  throws ApiException,
                         java.rmi.RemoteException
        Set the directory structure for the data directory.
        Parameters:
        dds - The new directory structure.
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - if the given directory structure is unknown to the API.

      • isGlobalAssessmentEnabled

        boolean isGlobalAssessmentEnabled()
                           throws java.rmi.RemoteException
        Returns:
        true, if the global assessment is enabled and false if not.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setGlobalAssessmentEnabled

        void setGlobalAssessmentEnabled​(boolean enabled)
                         throws java.rmi.RemoteException
        Parameters:
        enabled - or disable the execution of the global assessment.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getGlobalAssessmentScript

        java.lang.String getGlobalAssessmentScript()
                                    throws java.rmi.RemoteException
        Returns:
        the script from the global assessment.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setGlobalAssessmentScript

        void setGlobalAssessmentScript​(java.lang.String script)
                        throws java.rmi.RemoteException
        Parameters:
        script - that shall be executed during the global assessment.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getGlobalAssessmentRows

        RemoteList<GlobalAssessmentRow> getGlobalAssessmentRows()
                                                 throws java.rmi.RemoteException
        Returns:
        the list of global assessment rows
        Throws:
        java.rmi.RemoteException - remote communication problem

      • createGlobalAssessmentRow

        GlobalAssessmentRow createGlobalAssessmentRow()
                                       throws java.rmi.RemoteException
        Creates a new GlobalAssessmentRow and adds it to the tail of the GlobalAssessmentRows list. This list is represented by the table in the GUI.
        Returns:
        A fresh GlobalAssessmentRow
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getReportPackFile

        @Deprecated
java.io.File getReportPackFile()
                        throws java.rmi.RemoteException
        Deprecated.
        No support for $-variables and relative paths - use getReportPackPath() instead. Will be removed in TPT-18.
        Returns:
        Returns null if "Pack report" is not enabled. Otherwise, the target file for the ZIP is returned.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setReportPackFile

        @Deprecated
void setReportPackFile​(java.io.File zipFile)
                throws java.rmi.RemoteException
        Deprecated.
        No support for $-variables and relative paths - use setReportPackPath(String) instead. Will be removed in TPT-18.
        Set the ZIP file where the packed report should be stored. Using zipFile==null will disable the "Pack report" option.
        Parameters:
        zipFile - target file or null.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getReportPackPath

        @Deprecated
java.lang.String getReportPackPath()
                            throws java.rmi.RemoteException
        Deprecated.
        Use AdvancedReportSettings.getCompressionPath() instead. Will be removed in TPT-18.
        Returns:
        Returns null if "Pack report" is not enabled. Otherwise, the target file for the ZIP is returned.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setReportPackPath

        @Deprecated
void setReportPackPath​(java.lang.String zipFile)
                throws java.rmi.RemoteException
        Deprecated.
        Use AdvancedReportSettings.setCompressionPath(String) instead. Will be removed in TPT-18.
        Set the ZIP file where the packed report should be stored. Using zipFile==null will disable the "Pack report" option.
        Parameters:
        zipFile - target file or null.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isDeleteReportDirAfterPack

        @Deprecated
boolean isDeleteReportDirAfterPack()
                            throws java.rmi.RemoteException
        Deprecated.
        Use AdvancedReportSettings.isDeleteReportDirAfterCompression() instead. Will be removed in TPT-18.
        Returns:
        Returns true if the report directory should be deleted after it has been zipped by "Pack report".
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setDeleteReportDirAfterPack

        @Deprecated
void setDeleteReportDirAfterPack​(boolean enable)
                          throws java.rmi.RemoteException
        Deprecated.
        Use AdvancedReportSettings.setDeleteReportDirAfterCompression(boolean) instead. Will be removed in TPT-18.
        Parameters:
        enable - Enable or disable the automatic removal of the report directory if "Pack report" is enabled and after the report has been zipped.
        Throws:
        java.rmi.RemoteException - remote communication problem