Package com.piketec.tpt.api

Interface ExecutionConfigurationItem

    • Method Detail

      • getBack2BackSettings

        Back2BackSettings getBack2BackSettings​(boolean createIfUnavailable)
                                throws java.rmi.RemoteException
        Get the current back to back settings. If createIfUnavailable is true the return value is never null and new back to back settings are created with reference directory as reference if no settings are available yet.
        Parameters:
        createIfUnavailable - if true the result is never null and new setting are created if none are set.
        Returns:
        Returns the Back2BackSettings if already configured, creates and returns fresh settings if set to "No Reference Platform" and createIfUnavailable is true, null otherwise.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • removeBack2BackSettings

        void removeBack2BackSettings()
                      throws java.rmi.RemoteException
        Removes the back to back settings of this item (set reference to "No Reference Platform").
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getExecutionConfiguration

        ExecutionConfiguration getExecutionConfiguration()
                                          throws ApiException,
                                                 java.rmi.RemoteException
        Returns:
        The ExecutionConfiguration this instance belongs to.
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - If the instance does not belong to an ExecutionConfiguration and therefore is not part of a TPT model.

      • getIndex

        int getIndex()
      throws ApiException,
             java.rmi.RemoteException
        Returns:
        The index of this instance in its ExecutionConfiguration.
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - If the instance does not belong to a ExecutionConfiguration and therefore is not part of a TPT model.

      • setActive

        void setActive​(boolean active)
        throws java.rmi.RemoteException
        Enable or disable the execution of this ExecutionConfigItem in the parent ExecutionConfiguration.
        Parameters:
        active - true to enable, false otherwise
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isActive

        boolean isActive()
          throws java.rmi.RemoteException
        Returns:
        Returns whether this ExecutionConfigItem is enabled for execution or not.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getTestSet

        TestSet getTestSet()
            throws java.rmi.RemoteException
        Returns:
        Returns the selected test set or null if it set to "Selected test cases".
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getPlatformConfiguration

        PlatformConfiguration getPlatformConfiguration()
                                        throws java.rmi.RemoteException
        Returns:
        Returns the currently selected PlatformConfiguration or null if none has been selected so far.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getParameterFile

        @Deprecated
java.io.File getParameterFile()
                       throws java.rmi.RemoteException
        Deprecated.
        No support for $-variables and relative paths - use getParameterFilePath() instead. Will be removed in TPT-18.
        Returns:
        Returns the parameter file or null if none has been selected so far.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getParameterFilePath

        java.lang.String getParameterFilePath()
                               throws java.rmi.RemoteException
        Returns:
        The parameter file as String or null if none has yet been selected.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getVariables

        java.util.Map<java.lang.String,​java.lang.String> getVariables()
                                                             throws java.rmi.RemoteException
        Returns the variables defined for this ExecutionConfigurationItem.

        These variable could potentially overwrite variables defined in a parent scope. However, other variables defined in a parent scope are not returned by this function.

        Returns:
        A map containing the names of the "locally" defined variables and there "local" values.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setTestSet

        void setTestSet​(TestSet ts)
         throws java.rmi.RemoteException
        Set a TestSet for this ExecutionConfigurationItem.
        Parameters:
        ts - the test set to be set.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setPlatformConfiguration

        void setPlatformConfiguration​(PlatformConfiguration pc)
                       throws java.rmi.RemoteException
        Set a particular PlatformConfiguration for this ExecutionConfigurationItem.
        Parameters:
        pc - The Platform Configuration
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setParameterFile

        @Deprecated
void setParameterFile​(java.io.File f)
               throws java.rmi.RemoteException
        Deprecated.
        No support for $-variables and relative paths - use setParameterFilePath(String) instead. Will be removed in TPT-18.
        Set the parameter file as File or deletes the entry if f==null
        Parameters:
        f - The file containing the parameter set.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setParameterFilePath

        void setParameterFilePath​(java.lang.String path)
                   throws java.rmi.RemoteException
        Set the parameter file as String or delete the entry if path==null
        Parameters:
        path - A string containing the path to the parameter file.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setRunAssessments

        void setRunAssessments​(boolean run)
                throws java.rmi.RemoteException
        Enable or disable whether assessments should be executed for this ExecutionConfigItem.

        This option enables the user to omit the assessments for a particular Platform Configuration although the execution of assessments is enabled for the Execution Configuration.

        However, in the opposite case, disabling the assessment in the Execution Configuration and enabling it for the Platform will have no effect.

        Parameters:
        run - A Boolean indicating whether the assessments shall be run or not.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isRunAssessments

        boolean isRunAssessments()
                  throws java.rmi.RemoteException
        Returns:
        Returns true if assessments should be executed for this ExecutionConfigItem.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setVariable

        void setVariable​(java.lang.String name,
                 java.lang.String value)
          throws ApiException,
                 java.rmi.RemoteException
        Set the variables name to the given value or delete it, if value==null
        Parameters:
        name - The name of the variable
        value - Either the value for name or null to delete name
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - if name==null